Skip to content

Latest commit

 

History

History
160 lines (105 loc) · 7.31 KB

File metadata and controls

160 lines (105 loc) · 7.31 KB

\DeprecationNoticeAPI

All URIs are relative to https://all.api.keil.arm.com

Method HTTP request Description
GetDeprecationNotice Get /deprecations/{operationName} Return details of specific endpoint deprecation notice.
ListDeprecatedEndpoints Get /deprecations/ Get the endpoints that have been deprecated with some notice.

GetDeprecationNotice

EndpointDeprecationNotice GetDeprecationNotice(ctx, operationName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()

Return details of specific endpoint deprecation notice.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)

func main() {
	operationName := "operationName_example" // string | The name of the operation being deprecated.
	acceptVersion := "1.0.0" // string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. (optional)
	ifNoneMatch := "ifNoneMatch_example" // string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DeprecationNoticeAPI.GetDeprecationNotice(context.Background(), operationName).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DeprecationNoticeAPI.GetDeprecationNotice``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDeprecationNotice`: EndpointDeprecationNotice
	fmt.Fprintf(os.Stdout, "Response from `DeprecationNoticeAPI.GetDeprecationNotice`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
operationName string The name of the operation being deprecated.

Other Parameters

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

Name Type Description Notes

acceptVersion | string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. | ifNoneMatch | string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. |

Return type

EndpointDeprecationNotice

Authorization

TokenAuth

HTTP request headers

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

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

ListDeprecatedEndpoints

EndpointDeprecationNoticeCollection ListDeprecatedEndpoints(ctx).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()

Get the endpoints that have been deprecated with some notice.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ARM-software/embedded-development-services-client/client"
)

func main() {
	acceptVersion := "1.0.0" // string | Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning. (optional)
	ifNoneMatch := "ifNoneMatch_example" // string | Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content. (optional)
	limit := int32(20) // int32 | Paging: The maximum number of items to return in a resource. (optional) (default to 20)
	offset := int32(0) // int32 | Paging:  The index of the first item to return in the resource. (optional) (default to 0)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DeprecationNoticeAPI.ListDeprecatedEndpoints(context.Background()).AcceptVersion(acceptVersion).IfNoneMatch(ifNoneMatch).Limit(limit).Offset(offset).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DeprecationNoticeAPI.ListDeprecatedEndpoints``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListDeprecatedEndpoints`: EndpointDeprecationNoticeCollection
	fmt.Fprintf(os.Stdout, "Response from `DeprecationNoticeAPI.ListDeprecatedEndpoints`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
acceptVersion string Versioning: Optional header to request a specific version of the API. While it is possible to specify a particular major, minor or patch version it is not recommended for production use cases. Only the major version number should be specified as minor and patch versions can be updated without warning.
ifNoneMatch string Caching: Optional header to improve performance. The value of this header should be the `ETag` of the resource when last read. If this is provided and there have been no changes to the resource then a 304 will be returned without content.
limit int32 Paging: The maximum number of items to return in a resource. [default to 20]
offset int32 Paging: The index of the first item to return in the resource. [default to 0]

Return type

EndpointDeprecationNoticeCollection

Authorization

TokenAuth

HTTP request headers

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

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