| getapispecResult Structure Definition |
The getapispecResult structure defines the return type for getapispec API. |
Syntax |
Members |
rc |
If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings. |
message |
If the method succeeds, message is NULL else message contains Error/Warning message. |
apispecList |
List of apispecs |
| apispec Structure Definition |
The apispec structure defines the actual return type values for getapispec API. |
Syntax |
Members |
name |
Name of the spec for which to show detailed information. |
file |
Name of and, optionally, path to the api spec file. The spec file should be present on the appliance's hard-disk drive or solid-state drive. Storing a spec file in any location other than the default might cause inconsistency in a high availability setup. /nsconfig/apispec/ is the default path. |
type |
Input format of the spec file. The three formats supported by the appliance are:
PROTO
OAS/Swagger
GRAPHQL |
apiname |
API method used for display purposes |
apiservice |
API endpoint (could be GRPC service, REST path) used for display purposes |
httpmethod |
GRPC API option method: REST way to reach GRPC Service. One per service/method combination |
httpurlpath |
GRPC API option endpoint: REST way to reach GRPC Service. One per service/method combination |
skipvalidation |
Disabling openapi spec validation while adding it |
encrypted |
Specify the encrypted API spec. Must be in NetScaler format |
builtin |
ready |
Indicates whether apec is ready, that is internal registry created or not |
nsappversion |
NS App Version of the api spec file |
_nextgenapiresource |
See Also |