apidocs

type ApiDocumentationGenerator struct{}

type ApiOverview struct {
	Api struct {
		Name               string
		Version            string
		BaseUrl            string
		Protocol           string
		AuthType           string
		Deprecated         bool
		ReplacementVersion string
		SunsetDate         string
		Beta               bool
		StabilityLevel     string
	}
	Changelog struct {
		HasBreakingChanges bool
		BreakingChanges    string
		NewFeatures        string
		Improvements       string
		BugFixes           string
	}
	Docs struct {
		MigrationUrl string
	}
	Auth struct {
		Type         string
		Required     bool
		DashboardUrl string
		OauthFlow    string
		Scopes       string
		AuthUrl      string
		TokenUrl     string
		ScopeCount   int
		ScopeList    string
		HeaderName   string
		QueryParam   string
		RateLimits   bool
	}
	RateLimits struct {
		StandardRequests int
		StandardWindow   string
		PremiumRequests  int
		PremiumWindow    string
		HasBurst         bool
		BurstRequests    int
		BurstWindow      string
	}
}

type EndpointDocumentation struct {
	Endpoints struct {
		Count          int
		HasCategories  bool
		UserManagement bool
		UserCount      int
		DataOperations bool
		DataCount      int
		Analytics      bool
		AnalyticsCount int
		Webhooks       bool
		WebhookCount   int
	}
	Endpoint struct {
		Featured         bool
		Name             string
		Method           string
		Path             string
		Description      string
		RequiresAuth     bool
		HasPathParams    bool
		PathParams       string
		ParamName        string
		ParamType        string
		ParamRequired    bool
		ParamDescription string
		HasQueryParams   bool
		QueryParams      string
		QueryName        string
		QueryType        string
		QueryRequired    bool
		QueryDefault     string
		QueryDescription string
		HasBody          bool
		RequestBody      string
		RequestSchema    string
		SuccessCodes     string
		ResponseExample  string
		HasErrorCodes    bool
		ErrorCodes       string
		ErrorCode        int
		ErrorDescription string
		ErrorSolution    string
		CurlBody         string
		JsBody           string
		PythonBody       string
		MethodLower      string
		NoBody           bool
		GoBody           string
	}
	Api struct {
		BaseUrl string
	}
	Examples struct {
		Curl       bool
		Javascript bool
		Python     bool
		Go         bool
	}
}

type SchemaReference struct {
	Schemas struct {
		Available bool
		Count     int
		Schema1   struct {
			Name            string
			Description     string
			Example         string
			Properties      string
			HasValidation   bool
			ValidationRules string
		}
		FieldName        string
		FieldType        string
		FieldRequired    bool
		FieldDescription string
	}
}

type SdksAndTools struct {
	Sdks struct {
		Available      bool
		OfficialCount  int
		Javascript     bool
		JsPackage      string
		JsDocs         string
		JsVersion      string
		JsSize         string
		Python         bool
		PythonPackage  string
		PythonDocs     string
		PythonVersion  string
		PythonCompat   string
		Go             bool
		GoPackage      string
		GoDocs         string
		GoVersion      string
		GoCompat       string
		Ruby           bool
		RubyPackage    string
		RubyDocs       string
		RubyVersion    string
		CommunityCount int
		CommunityList  string
	}
	Tools struct {
		Postman     bool
		PostmanUrl  string
		Openapi     bool
		OpenapiUrl  string
		SwaggerUrl  string
		Insomnia    bool
		InsomniaUrl string
	}
}

type SupportAndResources struct {
	Support struct {
		HasPremium          bool
		PremiumResponseTime string
		PremiumEmail        string
		PremiumPhone        string
		PremiumSlack        string
		Discord             string
		StackoverflowTag    string
		GithubIssues        string
		StatusPage          bool
		StatusUrl           string
		SlaUptime           string
		CurrentStatus       string
	}
	Docs struct {
		TutorialsUrl     string
		BestPracticesUrl string
		ChangelogUrl     string
		Version          string
		LastUpdated      string
	}
	Api struct {
		Version string
	}
	Company struct {
		Name string
	}
}