abp/modules/docs/src/Volo.Docs.HttpApi/Volo.Docs.HttpApi.abppkg.analyze.json

{
  "name": "Volo.Docs.HttpApi",
  "hash": "",
  "contents": [
    {
      "namespace": "Volo.Docs",
      "dependsOnModules": [
        {
          "declaringAssemblyName": "Volo.Docs.Application.Contracts",
          "namespace": "Volo.Docs",
          "name": "DocsApplicationContractsModule"
        },
        {
          "declaringAssemblyName": "Volo.Abp.AspNetCore.Mvc",
          "namespace": "Volo.Abp.AspNetCore.Mvc",
          "name": "AbpAspNetCoreMvcModule"
        }
      ],
      "implementingInterfaces": [
        {
          "name": "IAbpModule",
          "namespace": "Volo.Abp.Modularity",
          "declaringAssemblyName": "Volo.Abp.Core",
          "fullName": "Volo.Abp.Modularity.IAbpModule"
        },
        {
          "name": "IOnPreApplicationInitialization",
          "namespace": "Volo.Abp.Modularity",
          "declaringAssemblyName": "Volo.Abp.Core",
          "fullName": "Volo.Abp.Modularity.IOnPreApplicationInitialization"
        },
        {
          "name": "IOnApplicationInitialization",
          "namespace": "Volo.Abp",
          "declaringAssemblyName": "Volo.Abp.Core",
          "fullName": "Volo.Abp.IOnApplicationInitialization"
        },
        {
          "name": "IOnPostApplicationInitialization",
          "namespace": "Volo.Abp.Modularity",
          "declaringAssemblyName": "Volo.Abp.Core",
          "fullName": "Volo.Abp.Modularity.IOnPostApplicationInitialization"
        },
        {
          "name": "IOnApplicationShutdown",
          "namespace": "Volo.Abp",
          "declaringAssemblyName": "Volo.Abp.Core",
          "fullName": "Volo.Abp.IOnApplicationShutdown"
        },
        {
          "name": "IPreConfigureServices",
          "namespace": "Volo.Abp.Modularity",
          "declaringAssemblyName": "Volo.Abp.Core",
          "fullName": "Volo.Abp.Modularity.IPreConfigureServices"
        },
        {
          "name": "IPostConfigureServices",
          "namespace": "Volo.Abp.Modularity",
          "declaringAssemblyName": "Volo.Abp.Core",
          "fullName": "Volo.Abp.Modularity.IPostConfigureServices"
        }
      ],
      "contentType": "abpModule",
      "name": "DocsHttpApiModule",
      "summary": null
    },
    {
      "apis": [
        {
          "path": "api/docs/projects",
          "method": "GET",
          "groupName": "DocsProject",
          "responseType": "Volo.Abp.Application.Dtos.ListResultDto`1[Volo.Docs.Projects.ProjectDto]",
          "responseTypeAsJson": "",
          "parameterDescriptions": []
        },
        {
          "path": "api/docs/projects/{shortName}",
          "method": "GET",
          "groupName": "DocsProject",
          "responseType": "Volo.Docs.Projects.ProjectDto",
          "responseTypeAsJson": "",
          "parameterDescriptions": [
            {
              "name": "shortName",
              "type": "String"
            }
          ]
        },
        {
          "path": "api/docs/projects/{shortName}/defaultLanguage",
          "method": "GET",
          "groupName": "DocsProject",
          "responseType": "System.String",
          "responseTypeAsJson": "\"string\"",
          "parameterDescriptions": [
            {
              "name": "shortName",
              "type": "String"
            },
            {
              "name": "version",
              "type": "String"
            }
          ]
        },
        {
          "path": "api/docs/projects/{shortName}/versions",
          "method": "GET",
          "groupName": "DocsProject",
          "responseType": "Volo.Abp.Application.Dtos.ListResultDto`1[Volo.Docs.Projects.VersionInfoDto]",
          "responseTypeAsJson": "{\r\n  \"items\": [\r\n    {\r\n      \"displayName\": \"string\",\r\n      \"name\": \"string\"\r\n    }\r\n  ]\r\n}",
          "parameterDescriptions": [
            {
              "name": "shortName",
              "type": "String"
            }
          ]
        },
        {
          "path": "api/docs/projects/{shortName}/{version}/languageList",
          "method": "GET",
          "groupName": "DocsProject",
          "responseType": "Volo.Docs.Documents.LanguageConfig",
          "responseTypeAsJson": "{\r\n  \"languages\": [\r\n    {\r\n      \"displayName\": \"string\",\r\n      \"code\": \"string\",\r\n      \"isDefault\": false\r\n    }\r\n  ]\r\n}",
          "parameterDescriptions": [
            {
              "name": "shortName",
              "type": "String"
            },
            {
              "name": "version",
              "type": "String"
            }
          ]
        },
        {
          "path": "api/docs/documents",
          "method": "GET",
          "groupName": "DocsDocument",
          "responseType": "Volo.Docs.Documents.DocumentWithDetailsDto",
          "responseTypeAsJson": "",
          "parameterDescriptions": [
            {
              "name": "ProjectId",
              "type": "Guid"
            },
            {
              "name": "Name",
              "type": "String"
            },
            {
              "name": "Version",
              "type": "String"
            },
            {
              "name": "LanguageCode",
              "type": "String"
            }
          ]
        },
        {
          "path": "api/docs/documents/default",
          "method": "GET",
          "groupName": "DocsDocument",
          "responseType": "Volo.Docs.Documents.DocumentWithDetailsDto",
          "responseTypeAsJson": "",
          "parameterDescriptions": [
            {
              "name": "ProjectId",
              "type": "Guid"
            },
            {
              "name": "Version",
              "type": "String"
            },
            {
              "name": "LanguageCode",
              "type": "String"
            }
          ]
        },
        {
          "path": "api/docs/documents/navigation",
          "method": "GET",
          "groupName": "DocsDocument",
          "responseType": "Volo.Docs.Documents.NavigationNode",
          "responseTypeAsJson": "",
          "parameterDescriptions": [
            {
              "name": "ProjectId",
              "type": "Guid"
            },
            {
              "name": "Version",
              "type": "String"
            },
            {
              "name": "LanguageCode",
              "type": "String"
            }
          ]
        },
        {
          "path": "api/docs/documents/resource",
          "method": "GET",
          "groupName": "DocsDocument",
          "responseType": "Volo.Docs.Documents.DocumentResourceDto",
          "responseTypeAsJson": "",
          "parameterDescriptions": [
            {
              "name": "ProjectId",
              "type": "Guid"
            },
            {
              "name": "Name",
              "type": "String"
            },
            {
              "name": "Version",
              "type": "String"
            },
            {
              "name": "LanguageCode",
              "type": "String"
            }
          ]
        },
        {
          "path": "api/docs/documents/search",
          "method": "POST",
          "groupName": "DocsDocument",
          "responseType": "Volo.Abp.Application.Dtos.PagedResultDto`1[Volo.Docs.Documents.DocumentSearchOutput]",
          "responseTypeAsJson": "{\r\n  \"totalCount\": 0,\r\n  \"items\": [\r\n    {\r\n      \"name\": \"string\",\r\n      \"fileName\": \"string\",\r\n      \"version\": \"string\",\r\n      \"languageCode\": \"string\",\r\n      \"highlight\": [\r\n        \"string\"\r\n      ]\r\n    }\r\n  ]\r\n}",
          "parameterDescriptions": [
            {
              "name": "input",
              "type": "DocumentSearchInput"
            }
          ]
        },
        {
          "path": "api/docs/documents/full-search-enabled",
          "method": "GET",
          "groupName": "DocsDocument",
          "responseType": "System.Boolean",
          "responseTypeAsJson": "true",
          "parameterDescriptions": []
        },
        {
          "path": "api/docs/documents/links",
          "method": "GET",
          "groupName": "DocsDocument",
          "responseType": "System.Collections.Generic.List`1[System.String]",
          "responseTypeAsJson": "[\r\n  \"string\"\r\n]",
          "parameterDescriptions": [
            {
              "name": "prefix",
              "type": "String"
            }
          ]
        },
        {
          "path": "api/docs/documents/parameters",
          "method": "GET",
          "groupName": "DocsDocument",
          "responseType": "Volo.Docs.Documents.DocumentParametersDto",
          "responseTypeAsJson": "{\r\n  \"parameters\": [\r\n    {\r\n      \"name\": \"string\",\r\n      \"displayName\": \"string\",\r\n      \"values\": {\r\n        \"string\": \"string\"\r\n      }\r\n    }\r\n  ]\r\n}",
          "parameterDescriptions": [
            {
              "name": "ProjectId",
              "type": "Guid"
            },
            {
              "name": "Version",
              "type": "String"
            },
            {
              "name": "LanguageCode",
              "type": "String"
            }
          ]
        }
      ],
      "contentType": "httpApi",
      "name": "Defined Http Apis",
      "summary": null
    }
  ]
}