Skip to content

EndpointsAPI.md

Latest commit

 

History

History
79 lines (48 loc) · 2.33 KB

EndpointsAPI.md

File metadata and controls

79 lines (48 loc) · 2.33 KB

\EndpointsAPI

All URIs are relative to http://localhost

Method HTTP request Description
GetOpenAPI Get /api/v2/endpoints/{apiType}

GetOpenAPI

string GetOpenAPI(ctx, apiType).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonatypeiq "github.com/sonatype-nexus-community/nexus-iq-api-client-go"
)

func main() {
	apiType := "apiType_example" // string | Select the type of the API.<ul><li> `public` APIs are Generally Available and fully supported by Sonatype.</li><li> `experimental` APIs are not production ready, may change, and are not intended to be used in critical workloads.</li></ul>

	configuration := sonatypeiq.NewConfiguration()
	apiClient := sonatypeiq.NewAPIClient(configuration)
	resp, r, err := apiClient.EndpointsAPI.GetOpenAPI(context.Background(), apiType).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EndpointsAPI.GetOpenAPI``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetOpenAPI`: string
	fmt.Fprintf(os.Stdout, "Response from `EndpointsAPI.GetOpenAPI`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiType string Select the type of the API.<ul><li> `public` APIs are Generally Available and fully supported by Sonatype.</li><li> `experimental` APIs are not production ready, may change, and are not intended to be used in critical workloads.</li></ul>

Other Parameters

Other parameters are passed through a pointer to a apiGetOpenAPIRequest struct via the builder pattern

Name Type Description Notes

Return type

string

Authorization

BasicAuth, BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]