Documentation ¶
Index ¶
- Constants
- Variables
- func Bool(b bool) *bool
- func Float32(f float32) *float32
- func Float64(f float64) *float64
- func Int(i int) *int
- func Int64(i int64) *int64
- func String(s string) *string
- type APIEndpoints
- func (s *APIEndpoints) DeleteAPIEndpoint(ctx context.Context, request operations.DeleteAPIEndpointRequest) (*operations.DeleteAPIEndpointResponse, error)
- func (s *APIEndpoints) FindAPIEndpoint(ctx context.Context, request operations.FindAPIEndpointRequest) (*operations.FindAPIEndpointResponse, error)
- func (s *APIEndpoints) GenerateOpenAPISpecForAPIEndpoint(ctx context.Context, ...) (*operations.GenerateOpenAPISpecForAPIEndpointResponse, error)
- func (s *APIEndpoints) GeneratePostmanCollectionForAPIEndpoint(ctx context.Context, ...) (*operations.GeneratePostmanCollectionForAPIEndpointResponse, error)
- func (s *APIEndpoints) GetAPIEndpoint(ctx context.Context, request operations.GetAPIEndpointRequest) (*operations.GetAPIEndpointResponse, error)
- func (s *APIEndpoints) GetAllAPIEndpoints(ctx context.Context, request operations.GetAllAPIEndpointsRequest) (*operations.GetAllAPIEndpointsResponse, error)
- func (s *APIEndpoints) GetAllForVersionAPIEndpoints(ctx context.Context, request operations.GetAllForVersionAPIEndpointsRequest) (*operations.GetAllForVersionAPIEndpointsResponse, error)
- func (s *APIEndpoints) UpsertAPIEndpoint(ctx context.Context, request operations.UpsertAPIEndpointRequest) (*operations.UpsertAPIEndpointResponse, error)
- type Apis
- func (s *Apis) DeleteAPI(ctx context.Context, request operations.DeleteAPIRequest) (*operations.DeleteAPIResponse, error)
- func (s *Apis) GenerateOpenAPISpec(ctx context.Context, request operations.GenerateOpenAPISpecRequest) (*operations.GenerateOpenAPISpecResponse, error)
- func (s *Apis) GeneratePostmanCollection(ctx context.Context, request operations.GeneratePostmanCollectionRequest, ...) (*operations.GeneratePostmanCollectionResponse, error)
- func (s *Apis) GetAllAPIVersions(ctx context.Context, request operations.GetAllAPIVersionsRequest) (*operations.GetAllAPIVersionsResponse, error)
- func (s *Apis) GetApis(ctx context.Context, request operations.GetApisRequest) (*operations.GetApisResponse, error)
- func (s *Apis) UpsertAPI(ctx context.Context, request operations.UpsertAPIRequest) (*operations.UpsertAPIResponse, error)
- type Artifacts
- func (s *Artifacts) GetBlob(ctx context.Context, request operations.GetBlobRequest, ...) (*operations.GetBlobResponse, error)
- func (s *Artifacts) GetManifest(ctx context.Context, request operations.GetManifestRequest, ...) (*operations.GetManifestResponse, error)
- func (s *Artifacts) GetNamespaces(ctx context.Context) (*operations.GetNamespacesResponse, error)
- func (s *Artifacts) GetRevisions(ctx context.Context, request operations.GetRevisionsRequest) (*operations.GetRevisionsResponse, error)
- func (s *Artifacts) GetTags(ctx context.Context, request operations.GetTagsRequest) (*operations.GetTagsResponse, error)
- func (s *Artifacts) Preflight(ctx context.Context, request *shared.PreflightRequest) (*operations.PreflightResponse, error)
- type Auth
- func (s *Auth) GetAccessToken(ctx context.Context, request operations.GetAccessTokenRequest) (*operations.GetAccessTokenResponse, error)
- func (s *Auth) GetUser(ctx context.Context) (*operations.GetUserResponse, error)
- func (s *Auth) GetWorkspaceAccess(ctx context.Context, request operations.GetWorkspaceAccessRequest, ...) (*operations.GetWorkspaceAccessResponse, error)
- func (s *Auth) ValidateAPIKey(ctx context.Context) (*operations.ValidateAPIKeyResponse, error)
- type Embeds
- func (s *Embeds) GetEmbedAccessToken(ctx context.Context, request operations.GetEmbedAccessTokenRequest) (*operations.GetEmbedAccessTokenResponse, error)
- func (s *Embeds) GetValidEmbedAccessTokens(ctx context.Context) (*operations.GetValidEmbedAccessTokensResponse, error)
- func (s *Embeds) RevokeEmbedAccessToken(ctx context.Context, request operations.RevokeEmbedAccessTokenRequest) (*operations.RevokeEmbedAccessTokenResponse, error)
- type Events
- func (s *Events) GetWorkspaceEvents(ctx context.Context, request operations.GetWorkspaceEventsRequest) (*operations.GetWorkspaceEventsResponse, error)
- func (s *Events) GetWorkspaceTargets(ctx context.Context, request operations.GetWorkspaceTargetsRequest) (*operations.GetWorkspaceTargetsResponse, error)
- func (s *Events) PostWorkspaceEvents(ctx context.Context, request operations.PostWorkspaceEventsRequest, ...) (*operations.PostWorkspaceEventsResponse, error)
- type HTTPClient
- type Metadata
- func (s *Metadata) DeleteVersionMetadata(ctx context.Context, request operations.DeleteVersionMetadataRequest) (*operations.DeleteVersionMetadataResponse, error)
- func (s *Metadata) GetVersionMetadata(ctx context.Context, request operations.GetVersionMetadataRequest) (*operations.GetVersionMetadataResponse, error)
- func (s *Metadata) InsertVersionMetadata(ctx context.Context, request operations.InsertVersionMetadataRequest) (*operations.InsertVersionMetadataResponse, error)
- type Organizations
- type Reports
- func (s *Reports) GetLintingReportSignedURL(ctx context.Context, request operations.GetLintingReportSignedURLRequest) (*operations.GetLintingReportSignedURLResponse, error)
- func (s *Reports) UploadReport(ctx context.Context, request operations.UploadReportRequestBody) (*operations.UploadReportResponse, error)
- type Requests
- func (s *Requests) GenerateRequestPostmanCollection(ctx context.Context, ...) (*operations.GenerateRequestPostmanCollectionResponse, error)
- func (s *Requests) GetRequestFromEventLog(ctx context.Context, request operations.GetRequestFromEventLogRequest) (*operations.GetRequestFromEventLogResponse, error)
- func (s *Requests) QueryEventLog(ctx context.Context, request operations.QueryEventLogRequest) (*operations.QueryEventLogResponse, error)
- type SDKOption
- func WithClient(client HTTPClient) SDKOption
- func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption
- func WithSecurity(security shared.Security) SDKOption
- func WithSecuritySource(security func(context.Context) (shared.Security, error)) SDKOption
- func WithServer(server string) SDKOption
- func WithServerURL(serverURL string) SDKOption
- func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption
- func WithWorkspaceID(workspaceID string) SDKOption
- type Schemas
- func (s *Schemas) DeleteSchema(ctx context.Context, request operations.DeleteSchemaRequest) (*operations.DeleteSchemaResponse, error)
- func (s *Schemas) DownloadSchema(ctx context.Context, request operations.DownloadSchemaRequest, ...) (*operations.DownloadSchemaResponse, error)
- func (s *Schemas) DownloadSchemaRevision(ctx context.Context, request operations.DownloadSchemaRevisionRequest, ...) (*operations.DownloadSchemaRevisionResponse, error)
- func (s *Schemas) GetSchema(ctx context.Context, request operations.GetSchemaRequest) (*operations.GetSchemaResponse, error)
- func (s *Schemas) GetSchemaDiff(ctx context.Context, request operations.GetSchemaDiffRequest) (*operations.GetSchemaDiffResponse, error)
- func (s *Schemas) GetSchemaRevision(ctx context.Context, request operations.GetSchemaRevisionRequest) (*operations.GetSchemaRevisionResponse, error)
- func (s *Schemas) GetSchemas(ctx context.Context, request operations.GetSchemasRequest) (*operations.GetSchemasResponse, error)
- func (s *Schemas) RegisterSchema(ctx context.Context, request operations.RegisterSchemaRequest) (*operations.RegisterSchemaResponse, error)
- type Speakeasy
Constants ¶
const (
ServerProd string = "prod"
)
Variables ¶
var ServerList = map[string]string{ ServerProd: "https://api.prod.speakeasyapi.dev", }
ServerList contains the list of servers available to the SDK
Functions ¶
Types ¶
type APIEndpoints ¶
type APIEndpoints struct {
// contains filtered or unexported fields
}
APIEndpoints - REST APIs for managing ApiEndpoint entities
func (*APIEndpoints) DeleteAPIEndpoint ¶
func (s *APIEndpoints) DeleteAPIEndpoint(ctx context.Context, request operations.DeleteAPIEndpointRequest) (*operations.DeleteAPIEndpointResponse, error)
DeleteAPIEndpoint - Delete an ApiEndpoint. Delete an ApiEndpoint. This will also delete all associated Request Logs (if using a Postgres datastore).
func (*APIEndpoints) FindAPIEndpoint ¶
func (s *APIEndpoints) FindAPIEndpoint(ctx context.Context, request operations.FindAPIEndpointRequest) (*operations.FindAPIEndpointResponse, error)
FindAPIEndpoint - Find an ApiEndpoint via its displayName. Find an ApiEndpoint via its displayName (set by operationId from a registered OpenAPI schema). This is useful for finding the ID of an ApiEndpoint to use in the /v1/apis/{apiID}/version/{versionID}/api_endpoints/{apiEndpointID} endpoints.
func (*APIEndpoints) GenerateOpenAPISpecForAPIEndpoint ¶
func (s *APIEndpoints) GenerateOpenAPISpecForAPIEndpoint(ctx context.Context, request operations.GenerateOpenAPISpecForAPIEndpointRequest) (*operations.GenerateOpenAPISpecForAPIEndpointResponse, error)
GenerateOpenAPISpecForAPIEndpoint - Generate an OpenAPI specification for a particular ApiEndpoint. This endpoint will generate a new operation in any registered OpenAPI document if the operation does not already exist in the document. Returns the original document and the newly generated document allowing a diff to be performed to see what has changed.
func (*APIEndpoints) GeneratePostmanCollectionForAPIEndpoint ¶
func (s *APIEndpoints) GeneratePostmanCollectionForAPIEndpoint(ctx context.Context, request operations.GeneratePostmanCollectionForAPIEndpointRequest, opts ...operations.Option) (*operations.GeneratePostmanCollectionForAPIEndpointResponse, error)
GeneratePostmanCollectionForAPIEndpoint - Generate a Postman collection for a particular ApiEndpoint. Generates a postman collection that allows the endpoint to be called from postman variables produced for any path/query/header parameters included in the OpenAPI document.
func (*APIEndpoints) GetAPIEndpoint ¶
func (s *APIEndpoints) GetAPIEndpoint(ctx context.Context, request operations.GetAPIEndpointRequest) (*operations.GetAPIEndpointResponse, error)
GetAPIEndpoint - Get an ApiEndpoint.
func (*APIEndpoints) GetAllAPIEndpoints ¶
func (s *APIEndpoints) GetAllAPIEndpoints(ctx context.Context, request operations.GetAllAPIEndpointsRequest) (*operations.GetAllAPIEndpointsResponse, error)
GetAllAPIEndpoints - Get all Api endpoints for a particular apiID.
func (*APIEndpoints) GetAllForVersionAPIEndpoints ¶
func (s *APIEndpoints) GetAllForVersionAPIEndpoints(ctx context.Context, request operations.GetAllForVersionAPIEndpointsRequest) (*operations.GetAllForVersionAPIEndpointsResponse, error)
GetAllForVersionAPIEndpoints - Get all ApiEndpoints for a particular apiID and versionID.
func (*APIEndpoints) UpsertAPIEndpoint ¶
func (s *APIEndpoints) UpsertAPIEndpoint(ctx context.Context, request operations.UpsertAPIEndpointRequest) (*operations.UpsertAPIEndpointResponse, error)
UpsertAPIEndpoint - Upsert an ApiEndpoint. Upsert an ApiEndpoint. If the ApiEndpoint does not exist it will be created, otherwise it will be updated.
type Apis ¶
type Apis struct {
// contains filtered or unexported fields
}
Apis - REST APIs for managing Api entities
func (*Apis) DeleteAPI ¶
func (s *Apis) DeleteAPI(ctx context.Context, request operations.DeleteAPIRequest) (*operations.DeleteAPIResponse, error)
DeleteAPI - Delete an Api. Delete a particular version of an Api. The will also delete all associated ApiEndpoints, Metadata, Schemas & Request Logs (if using a Postgres datastore).
func (*Apis) GenerateOpenAPISpec ¶
func (s *Apis) GenerateOpenAPISpec(ctx context.Context, request operations.GenerateOpenAPISpecRequest) (*operations.GenerateOpenAPISpecResponse, error)
GenerateOpenAPISpec - Generate an OpenAPI specification for a particular Api. This endpoint will generate any missing operations in any registered OpenAPI document if the operation does not already exist in the document. Returns the original document and the newly generated document allowing a diff to be performed to see what has changed.
func (*Apis) GeneratePostmanCollection ¶
func (s *Apis) GeneratePostmanCollection(ctx context.Context, request operations.GeneratePostmanCollectionRequest, opts ...operations.Option) (*operations.GeneratePostmanCollectionResponse, error)
GeneratePostmanCollection - Generate a Postman collection for a particular Api. Generates a postman collection containing all endpoints for a particular API. Includes variables produced for any path/query/header parameters included in the OpenAPI document.
func (*Apis) GetAllAPIVersions ¶
func (s *Apis) GetAllAPIVersions(ctx context.Context, request operations.GetAllAPIVersionsRequest) (*operations.GetAllAPIVersionsResponse, error)
GetAllAPIVersions - Get all Api versions for a particular ApiEndpoint. Get all Api versions for a particular ApiEndpoint. Supports filtering the versions based on metadata attributes.
func (*Apis) GetApis ¶
func (s *Apis) GetApis(ctx context.Context, request operations.GetApisRequest) (*operations.GetApisResponse, error)
GetApis - Get a list of Apis for a given workspace Get a list of all Apis and their versions for a given workspace. Supports filtering the APIs based on metadata attributes.
func (*Apis) UpsertAPI ¶
func (s *Apis) UpsertAPI(ctx context.Context, request operations.UpsertAPIRequest) (*operations.UpsertAPIResponse, error)
UpsertAPI - Upsert an Api Upsert an Api. If the Api does not exist, it will be created. If the Api exists, it will be updated.
type Artifacts ¶ added in v3.5.3
type Artifacts struct {
// contains filtered or unexported fields
}
func (*Artifacts) GetBlob ¶ added in v3.5.4
func (s *Artifacts) GetBlob(ctx context.Context, request operations.GetBlobRequest, opts ...operations.Option) (*operations.GetBlobResponse, error)
GetBlob - Get blob for a particular digest
func (*Artifacts) GetManifest ¶ added in v3.5.4
func (s *Artifacts) GetManifest(ctx context.Context, request operations.GetManifestRequest, opts ...operations.Option) (*operations.GetManifestResponse, error)
GetManifest - Get manifest for a particular reference
func (*Artifacts) GetNamespaces ¶ added in v3.5.3
func (s *Artifacts) GetNamespaces(ctx context.Context) (*operations.GetNamespacesResponse, error)
GetNamespaces - Each namespace contains many revisions.
func (*Artifacts) GetRevisions ¶ added in v3.5.3
func (s *Artifacts) GetRevisions(ctx context.Context, request operations.GetRevisionsRequest) (*operations.GetRevisionsResponse, error)
func (*Artifacts) GetTags ¶ added in v3.5.4
func (s *Artifacts) GetTags(ctx context.Context, request operations.GetTagsRequest) (*operations.GetTagsResponse, error)
func (*Artifacts) Preflight ¶ added in v3.5.3
func (s *Artifacts) Preflight(ctx context.Context, request *shared.PreflightRequest) (*operations.PreflightResponse, error)
Preflight - Get access token for communicating with OCI distribution endpoints
type Auth ¶ added in v3.1.0
type Auth struct {
// contains filtered or unexported fields
}
Auth - REST APIs for managing Authentication
func (*Auth) GetAccessToken ¶ added in v3.3.11
func (s *Auth) GetAccessToken(ctx context.Context, request operations.GetAccessTokenRequest) (*operations.GetAccessTokenResponse, error)
GetAccessToken - Get or refresh an access token for the current workspace.
func (*Auth) GetUser ¶ added in v3.4.6
func (s *Auth) GetUser(ctx context.Context) (*operations.GetUserResponse, error)
GetUser - Get information about the current user.
func (*Auth) GetWorkspaceAccess ¶ added in v3.2.2
func (s *Auth) GetWorkspaceAccess(ctx context.Context, request operations.GetWorkspaceAccessRequest, opts ...operations.Option) (*operations.GetWorkspaceAccessResponse, error)
GetWorkspaceAccess - Get access allowances for a particular workspace Checks if generation is permitted for a particular run of the CLI
func (*Auth) ValidateAPIKey ¶ added in v3.1.0
func (s *Auth) ValidateAPIKey(ctx context.Context) (*operations.ValidateAPIKeyResponse, error)
ValidateAPIKey - Validate the current api key.
type Embeds ¶
type Embeds struct {
// contains filtered or unexported fields
}
Embeds - REST APIs for managing embeds
func (*Embeds) GetEmbedAccessToken ¶
func (s *Embeds) GetEmbedAccessToken(ctx context.Context, request operations.GetEmbedAccessTokenRequest) (*operations.GetEmbedAccessTokenResponse, error)
GetEmbedAccessToken - Get an embed access token for the current workspace. Returns an embed access token for the current workspace. This can be used to authenticate access to externally embedded content. Filters can be applied allowing views to be filtered to things like particular customerIds.
func (*Embeds) GetValidEmbedAccessTokens ¶
func (s *Embeds) GetValidEmbedAccessTokens(ctx context.Context) (*operations.GetValidEmbedAccessTokensResponse, error)
GetValidEmbedAccessTokens - Get all valid embed access tokens for the current workspace.
func (*Embeds) RevokeEmbedAccessToken ¶
func (s *Embeds) RevokeEmbedAccessToken(ctx context.Context, request operations.RevokeEmbedAccessTokenRequest) (*operations.RevokeEmbedAccessTokenResponse, error)
RevokeEmbedAccessToken - Revoke an embed access EmbedToken.
type Events ¶ added in v3.1.0
type Events struct {
// contains filtered or unexported fields
}
Events - REST APIs for capturing event data
func (*Events) GetWorkspaceEvents ¶ added in v3.3.8
func (s *Events) GetWorkspaceEvents(ctx context.Context, request operations.GetWorkspaceEventsRequest) (*operations.GetWorkspaceEventsResponse, error)
GetWorkspaceEvents - Load recent events for a particular workspace
func (*Events) GetWorkspaceTargets ¶ added in v3.3.8
func (s *Events) GetWorkspaceTargets(ctx context.Context, request operations.GetWorkspaceTargetsRequest) (*operations.GetWorkspaceTargetsResponse, error)
GetWorkspaceTargets - Load targets for a particular workspace
func (*Events) PostWorkspaceEvents ¶ added in v3.1.0
func (s *Events) PostWorkspaceEvents(ctx context.Context, request operations.PostWorkspaceEventsRequest, opts ...operations.Option) (*operations.PostWorkspaceEventsResponse, error)
PostWorkspaceEvents - Post events for a specific workspace Sends an array of events to be stored for a particular workspace.
type HTTPClient ¶
HTTPClient provides an interface for suplying the SDK with a custom HTTP client
type Metadata ¶
type Metadata struct {
// contains filtered or unexported fields
}
Metadata - REST APIs for managing Version Metadata entities
func (*Metadata) DeleteVersionMetadata ¶
func (s *Metadata) DeleteVersionMetadata(ctx context.Context, request operations.DeleteVersionMetadataRequest) (*operations.DeleteVersionMetadataResponse, error)
DeleteVersionMetadata - Delete metadata for a particular apiID and versionID.
func (*Metadata) GetVersionMetadata ¶
func (s *Metadata) GetVersionMetadata(ctx context.Context, request operations.GetVersionMetadataRequest) (*operations.GetVersionMetadataResponse, error)
GetVersionMetadata - Get all metadata for a particular apiID and versionID.
func (*Metadata) InsertVersionMetadata ¶
func (s *Metadata) InsertVersionMetadata(ctx context.Context, request operations.InsertVersionMetadataRequest) (*operations.InsertVersionMetadataResponse, error)
InsertVersionMetadata - Insert metadata for a particular apiID and versionID.
type Organizations ¶ added in v3.4.2
type Organizations struct {
// contains filtered or unexported fields
}
func (*Organizations) GetOrganizations ¶ added in v3.4.2
func (s *Organizations) GetOrganizations(ctx context.Context) (*operations.GetOrganizationsResponse, error)
GetOrganizations - Get organizations for a user Returns a list of organizations a user has access too
type Reports ¶ added in v3.5.5
type Reports struct {
// contains filtered or unexported fields
}
Reports - REST APIs for managing reports
func (*Reports) GetLintingReportSignedURL ¶ added in v3.5.5
func (s *Reports) GetLintingReportSignedURL(ctx context.Context, request operations.GetLintingReportSignedURLRequest) (*operations.GetLintingReportSignedURLResponse, error)
GetLintingReportSignedURL - Get the signed access url for the linting reports for a particular document.
func (*Reports) UploadReport ¶ added in v3.5.5
func (s *Reports) UploadReport(ctx context.Context, request operations.UploadReportRequestBody) (*operations.UploadReportResponse, error)
UploadReport - Upload a report.
type Requests ¶
type Requests struct {
// contains filtered or unexported fields
}
Requests - REST APIs for retrieving request information
func (*Requests) GenerateRequestPostmanCollection ¶
func (s *Requests) GenerateRequestPostmanCollection(ctx context.Context, request operations.GenerateRequestPostmanCollectionRequest, opts ...operations.Option) (*operations.GenerateRequestPostmanCollectionResponse, error)
GenerateRequestPostmanCollection - Generate a Postman collection for a particular request. Generates a Postman collection for a particular request. Allowing it to be replayed with the same inputs that were captured by the SDK.
func (*Requests) GetRequestFromEventLog ¶
func (s *Requests) GetRequestFromEventLog(ctx context.Context, request operations.GetRequestFromEventLogRequest) (*operations.GetRequestFromEventLogResponse, error)
GetRequestFromEventLog - Get information about a particular request.
func (*Requests) QueryEventLog ¶
func (s *Requests) QueryEventLog(ctx context.Context, request operations.QueryEventLogRequest) (*operations.QueryEventLogResponse, error)
QueryEventLog - Query the event log to retrieve a list of requests. Supports retrieving a list of request captured by the SDK for this workspace. Allows the filtering of requests on a number of criteria such as ApiID, VersionID, Path, Method, etc.
type SDKOption ¶
type SDKOption func(*Speakeasy)
func WithClient ¶
func WithClient(client HTTPClient) SDKOption
WithClient allows the overriding of the default HTTP client used by the SDK
func WithRetryConfig ¶
func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption
func WithSecurity ¶
WithSecurity configures the SDK to use the provided security details
func WithSecuritySource ¶
WithSecuritySource configures the SDK to invoke the Security Source function on each method call to determine authentication
func WithServer ¶
WithServer allows the overriding of the default server by name
func WithServerURL ¶
WithServerURL allows the overriding of the default server URL
func WithTemplatedServerURL ¶
WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters
func WithWorkspaceID ¶ added in v3.1.0
WithWorkspaceID allows setting the WorkspaceID parameter for all supported operations
type Schemas ¶
type Schemas struct {
// contains filtered or unexported fields
}
Schemas - REST APIs for managing Schema entities
func (*Schemas) DeleteSchema ¶
func (s *Schemas) DeleteSchema(ctx context.Context, request operations.DeleteSchemaRequest) (*operations.DeleteSchemaResponse, error)
DeleteSchema - Delete a particular schema revision for an Api.
func (*Schemas) DownloadSchema ¶
func (s *Schemas) DownloadSchema(ctx context.Context, request operations.DownloadSchemaRequest, opts ...operations.Option) (*operations.DownloadSchemaResponse, error)
DownloadSchema - Download the latest schema for a particular apiID.
func (*Schemas) DownloadSchemaRevision ¶
func (s *Schemas) DownloadSchemaRevision(ctx context.Context, request operations.DownloadSchemaRevisionRequest, opts ...operations.Option) (*operations.DownloadSchemaRevisionResponse, error)
DownloadSchemaRevision - Download a particular schema revision for an Api.
func (*Schemas) GetSchema ¶
func (s *Schemas) GetSchema(ctx context.Context, request operations.GetSchemaRequest) (*operations.GetSchemaResponse, error)
GetSchema - Get information about the latest schema. Returns information about the last uploaded schema for a particular API version. This won't include the schema itself, that can be retrieved via the downloadSchema operation.
func (*Schemas) GetSchemaDiff ¶
func (s *Schemas) GetSchemaDiff(ctx context.Context, request operations.GetSchemaDiffRequest) (*operations.GetSchemaDiffResponse, error)
GetSchemaDiff - Get a diff of two schema revisions for an Api.
func (*Schemas) GetSchemaRevision ¶
func (s *Schemas) GetSchemaRevision(ctx context.Context, request operations.GetSchemaRevisionRequest) (*operations.GetSchemaRevisionResponse, error)
GetSchemaRevision - Get information about a particular schema revision for an Api. Returns information about the last uploaded schema for a particular schema revision. This won't include the schema itself, that can be retrieved via the downloadSchema operation.
func (*Schemas) GetSchemas ¶
func (s *Schemas) GetSchemas(ctx context.Context, request operations.GetSchemasRequest) (*operations.GetSchemasResponse, error)
GetSchemas - Get information about all schemas associated with a particular apiID. Returns information the schemas associated with a particular apiID. This won't include the schemas themselves, they can be retrieved via the downloadSchema operation.
func (*Schemas) RegisterSchema ¶
func (s *Schemas) RegisterSchema(ctx context.Context, request operations.RegisterSchemaRequest) (*operations.RegisterSchemaResponse, error)
RegisterSchema - Register a schema. Allows uploading a schema for a particular API version. This will be used to populate ApiEndpoints and used as a base for any schema generation if present.
type Speakeasy ¶
type Speakeasy struct { // REST APIs for managing Api entities Apis *Apis // REST APIs for managing ApiEndpoint entities APIEndpoints *APIEndpoints // REST APIs for managing Version Metadata entities Metadata *Metadata // REST APIs for managing Schema entities Schemas *Schemas Artifacts *Artifacts // REST APIs for managing Authentication Auth *Auth // REST APIs for retrieving request information Requests *Requests Organizations *Organizations // REST APIs for managing reports Reports *Reports // REST APIs for managing embeds Embeds *Embeds // REST APIs for capturing event data Events *Events // contains filtered or unexported fields }
Speakeasy API: The Speakeasy API allows teams to manage common operations with their APIs
/docs - The Speakeasy Platform Documentation