Meta tags:
description= Resolve OpenAPI errors like missing server URLs and 401 responses with clear steps to ensure proper API documentation and functionality.;
Headings (most frequently used words):
api, file, import, invalid, issues, documentation, format, upload, specification, not, top, troubleshooting, index, errors, still, having, faq, failed, url, unsupported, unable, to, add, reference, summary, and, tags, reflected, after, fails, with, 400, bad, request, too, large, level, tag, descriptions, rendered, in, document360, features, support, contact, us,
Text of the page (most frequently used words):
the (144), api (48), article (35), and (33), for (28), file (28), #document360 (26), when (26), endpoint (23), articles (21), response (20), not (19), openapi (18), your (16), this (15), occurs (14), that (14), documentation (13), with (13), use (13), why (13), published (12), url (12), yaml (12), support (11), editor (11), how (10), does (10), can (10), translated (10), specification (10), only (9), content (9), get (9), from (9), fix (9), are (9), happens (9), tags (9), slug (8), text (8), status (7), site (7), spec (7), endpoints (7), field (7), within (7), all (7), will (7), been (7), after (7), responses (7), open (7), valid (7), summary (7), reference (7), contact (6), knowledge (6), base (6), request (6), issues (6), list (6), return (6), project (6), version (6), returns (6), has (6), tag (6), type (6), import (6), upload (6), may (6), team (5), top (5), category (5), currently (5), used (5), ensure (5), user_id (5), user (5), invalid (5), operation (5), schema (5), level (5), one (5), json (5), format (5), 2026 (5), portal (4), troubleshooting (4), swagger (4), gets (4), filter (4), results (4), based (4), retrieve (4), publication (4), returned (4), available (4), each (4), multiple (4), required (4), using (4), redirect (4), language (4), modified (4), code (4), add (4), example (4), available_languages (4), languages (4), which (4), permissions (4), error (4), correct (4), try (4), during (4), across (4), fields (4), directly (4), contains (4), schemas (4), formatting (4), characters (4), page (4), about (3), workflow (3), analytics (3), integrations (3), features (3), getting (3), started (3), parameter (3), filtering (3), recommended (3), include (3), active (3), expected (3), review (3), check (3), different (3), longer (3), unexpected (3), access (3), you (3), such (3), categories (3), have (3), errors (3), requests (3), readers (3), objects (3), cannot (3), those (3), metadata (3), issue (3), descriptions (3), pages (3), any (3), description (3), defined (3), size (3), save (3), 201 (3), nested (3), remove (3), 400 (3), codes (3), uploading (3), incorrect (3), like (3), copy (3), rich (3), feature (3), ask (3), custom (3), policy (2), our (2), com (2), feedback (2), drive (2), extensions (2), private (2), hosting (2), interactive (2), decision (2), configuration (2), next (2), previous (2), yes (2), was (2), exists (2), individual (2), resource (2), ispublished (2), path (2), method (2), additional (2), information (2), filtered (2), ids (2), where (2), both (2), draft (2), supported (2), always (2), current (2), configured (2), respective (2), whether (2), rule (2), navigate (2), rules (2), creation (2), rather (2), than (2), original (2), subscription (2), activation (2), verify (2), previously (2), included (2), even (2), includes (2), belongs (2), being (2), service (2), complete (2), details (2), fork (2), unsupported (2), tryit (2), downtime (2), download (2), pdfs (2), structure (2), same (2), instances (2), publish (2), files (2), fetch (2), created (2), resolve (2), generated (2), into (2), folder (2), rendered (2), publishing (2), fails (2), deeply (2), retain (2), series (2), default (2), ide (2), although (2), pass (2), enforces (2), limit (2), more (2), folders (2), correctly (2), persists (2), inside (2), object (2), written (2), array (2), under (2), again (2), plain (2), word (2), trailing (2), backslashes (2), break (2), fs24 (2), uploaded (2), malformed (2), document (2), copied (2), exported (2), unable (2), 200 (2), application (2), empty (2), without (2), block (2), validation (2), claude (2), chatgpt (2), view (2), markdown (2), llms (2), ctrl (2), search (2), glossary (2), october (2), docs (2), index (2), soc2, cookie, privacy, trust, center, terms, careers, culture, 3000, rating, seo, ticket, deflector, platform, assistant, enterprise, readiness, security, migration, demo, resources, pricing, customers, managing, references, tree, fundamentals, related, helpful, but, provide, query, identifying, retrieving, extract, call, values, specified, regardless, their, state, identified, states, update, align, settings, its, initial, associated, translation, adding, requested, differs, unpublished, unpublish, should, least, once, actively, maintained, necessary, rights, edit, forked, automation, cases, dedicated, account, appropriate, calling, stale, misleading, implemented, mean, means, lacks, categoryid, occur, inactive, who, performed, receiving, making, automated, pipeline, behaviour, subdomain, internally, route, process, test, affect, functionality, calls, customer, run, independently, continue, accessing, scheduled, maintenance, there, option, through, follows, defines, consistent, static, reflect, variations, dynamically, approach, environments, separate, environment, vary, slightly, between, property, additionalproperties, dynamic, instance, modification, time, versions, timestamp, end, full, via, certain, date, faq, steps, above, still, having, relevant, context, visible, workaround, group, operations, converts, organising, generate, standalone, result, displayed, successful, require, backend, assistance, due, limitation, note, alone, types, entirely, external, validators, internal, eight, levels, deep, resulting, data, exceeds, processed, stored, per, bad, too, large, reimport, imported, value, title, move, additionally, must, delete, put, post, importing, display, titles, appear, reflected, cleaning, ensuring, special, avoid, processors, editing, saving, clean, especially, introduced, paste, source, these, look, unwanted, tool, validate, commonly, introduces, processor, completed, please, given, message, following, yml, supports, postman, collections, resolves, browser, curl, unreachable, servers, pointing, creating, provided, fetched, resolved, ref, components, yourschema, locate, definitions, strict, tools, requires, explicitly, define, media, wrapper, cause, missing, section, failed, consolidated, every, warning, behavior, documented, diagnose, imports, authentication, rendering, prev, print, listen, focus, minute, read, updated, jul, powered, press, community, self, help, november, release, notes, manage, integrate, manager, domain, customization, export, reminder, collaboration, tasks, trees, management, templates, variables, snippets, advanced, single, sign, role, control, workspaces, key, creators, eddy, track, set, roles, invite, users, customize, create, quick, start, discover, before, exploring, further, https, txt,
Text of the page (random words):
troubleshooting api import issues documentation index fetch the complete documentation index at https docs document360 com llms txt use this file to discover all available pages before exploring further quick start create an article review article publish article customize site invite users set up roles permissions track analytics eddy ai features for creators for readers for integrations key features multiple workspaces languages role based access control single sign on private hosting advanced editor templates variables snippets glossary drive file management custom fields interactive decision trees collaboration tasks custom workflow review reminder import export project site customization custom domain integrations extensions analytics feedback manager api documentation integrate with document360 manage your api docs release notes november 2026 12 11 1 october 2026 12 10 2 october 2026 12 10 1 help troubleshooting self service support ask for a feature community glossary search ctrl k press ctrl k to open search powered by troubleshooting api import issues updated on jul 27 2026 published on may 13 2026 9 minute s read focus listen print copy page copy as markdown for llms view as markdown view the page as plain text open in chatgpt ask chatgpt about this page open in claude ask claude about this page article summary prev next this article is a consolidated reference for every error warning and unexpected behavior documented across document360 s api documentation feature use it to diagnose and resolve issues with imports authentication the try it feature rendering and the knowledge base site import errors invalid format api file upload failed when it occurs when one or more responses in your openapi specification file are missing the required content section why it happens document360 enforces strict openapi validation rules although a file may pass validation in tools like swagger editor document360 requires all responses to explicitly define both the media type for example application json and a schema reference under a content block responses that are empty or that reference a schema directly without a content wrapper will cause this error how to fix it open your openapi spec file in a text editor or ide locate any response definitions that are empty or that reference a schema without a content block incorrect responses 200 correct responses 200 description ok content application json schema ref components schemas yourschema save the file and re upload it to document360 if the issue persists contact the document360 support team invalid url when it occurs when creating an api reference from a url and the url provided cannot be fetched or resolved why it happens the url may be malformed unreachable from document360 s servers or pointing to a resource that is not a valid openapi spec how to fix it verify the url resolves correctly in a browser or with curl ensure it returns a valid json or yaml openapi document correct the url and try again unsupported file format when it occurs when the uploaded file is not a supported format how to fix it ensure your file is one of the following json yaml or yml document360 supports openapi 2 0 openapi 3 0 openapi 3 1 and postman collections unable to add api reference invalid specification file error message unable to add api reference this operation can t be completed please ensure that you have given a valid specification file when it occurs when uploading a yaml specification file that has been copied or exported from a rich text editor or word processor why it happens the uploaded yaml file is malformed and not a valid openapi 3 0 yaml document this commonly occurs when the file has been copied or exported from a rich text editor which introduces formatting characters such as f0 fs24 or trailing backslashes that break the yaml format validate your spec file open your yaml file in a tool like swagger editor or a code editor to check for errors or formatting issues look for unwanted formatting characters check for characters like f0 fs24 or trailing backslashes especially in the endpoint description that may have been introduced during copy paste from a rich text source these can break the yaml format clean up the file use a plain text or code editor to remove any special formatting characters avoid using word processors when editing or saving yaml files re upload the file after cleaning the file and ensuring it s a valid openapi 3 0 yaml try uploading it again summary and tags not reflected after import when it occurs after importing a spec endpoint articles display incorrect titles or appear under unexpected category folders why it happens the summary and tags fields are defined at the path level in the spec rather than inside the operation object get post put or delete additionally the tags field must always be written as an array even when only one tag is used how to fix it open your openapi specification file in a text editor move the summary and tags fields inside each operation object and ensure tags is written as an array incorrect your endpoint summary my endpoint tags my category get correct your endpoint get summary my endpoint tags my category save the file and reimport it into document360 the imported articles will use the summary value as the article title and tag based folders will be created correctly if the issue persists contact the document360 support team upload fails with 400 bad request specification file too large when it occurs when uploading a valid yaml or json openapi specification file that contains endpoints with deeply nested response schemas and multiple response codes per endpoint why it happens although the file may be valid yaml and pass external validators such as swagger editor document360 enforces an internal article size limit when an endpoint contains response schemas nested eight or more levels deep across multiple response codes the resulting data size exceeds this limit and cannot be processed or stored how to fix it open your openapi specification file in a text editor or ide for each endpoint retain only one 201 response type one 400 series response type and the default response type remove all additional response codes for endpoints where the 201 response alone contains deeply nested schemas retain only the 201 response type and remove the 400 series and default response types entirely save the modified file and re upload it to document360 ℹ️ note if publishing fails after a successful upload contact the document360 support team publishing may require backend assistance due to the article size limitation top level tag descriptions not rendered in api documentation when it occurs descriptions and metadata defined in top level openapi tag objects are not displayed in the generated api documentation why it happens when an openapi specification file contains top level tags used to group api operations document360 converts those tags into folder type categories during import folder categories are used only for organising endpoints and do not generate standalone content pages as a result any description or metadata defined within those top level tag objects is not rendered workaround add the relevant context directly to the individual endpoint descriptions within the tag so the information is visible on the generated endpoint pages still having issues if the steps above do not resolve your issue contact the document360 support team directly faq can i filter api results by articles created or modified after a certain date the api does not support filtering articles directly by creation or modification time you can use the gets all article versions endpoint which includes a modified at timestamp in the metadata and filter the response on your end use the article id to fetch full content via the article details endpoint does document360 support dynamic or instance based api responses no document360 follows the openapi specification which defines a consistent static structure for request and response objects if your api returns different responses for the same endpoint across different instances document360 cannot reflect those variations dynamically the recommended approach is to use the same schema structure across all environments or to publish separate openapi spec files for each environment for fields that vary slightly between instances use the openapi additionalproperties property can i download articles as pdfs using the api currently there is no option to download articles as pdfs through the api endpoints can readers access the knowledge base site during document360 portal downtime yes get calls of the customer api run independently of the document360 portal so readers can continue accessing the site during scheduled maintenance or portal downtime why does the try it url include tryit document360 io this is expected behaviour the tryit document360 io subdomain is used internally to route and process api test requests it does not affect functionality requests return correct results from your api why am i receiving errors when making api requests from an automated workflow or ci cd pipeline this can occur if the user_id included in the api request belongs to an inactive user or a user who does not have the required permissions for the operation being performed example when calling fork endpoints such as v2 categories categoryid fork a stale or invalid user_id will return the misleading error the method or operation is not implemented this does not mean the endpoint is unsupported it means the user_id is invalid or the user lacks permissions fix ensure that the user_id belongs to an active document360 user with the necessary access rights for example edit permissions on the article or category being forked for automation use cases it is recommended to use a dedicated service account you can retrieve the appropriate user_id using the get complete user details by id api endpoint why does the api return unexpected languages in the available_languages field when it occurs this occurs when the available_languages field in the api response includes languages that are not currently expected to be available for the article why it happens the api returns all languages in which the article has been published at least once if a translated version of the article was published previously that language will be included in the available_languages field even if it is no longer actively maintained how to fix it navigate to the article in the respective language verify whether the translated article has been published previously unpublish the translated article if it should no longer be available after the translated article is unpublished the language will no longer be returned in the available_languages field of the api response why does the api return a different slug for translated articles when it occurs this occurs when the slug returned for a translated article differs from the slug used in the original api request example requested slug add subscription activation code returned translation slug adding your subscription with your activation code why it happens the url of the translated article has been modified after its initial creation and a redirect rule has been configured for the previous url the api returns the current active slug associated with the translated article rather than the original slug how to fix it navigate to settings knowledge base site article redirect rules check whether a redirect rule exists for the translated article review the current url configured for the article in the respective language if required update the article url or redirect configuration to align with the expected slug the api will always return the currently active url for the translated article how can i retrieve only published articles when using the get list of articles within a project version api endpoint when it occurs this occurs when the get list of articles within a project version api endpoint returns articles in multiple publication states and only published articles are required why it happens the endpoint returns all articles available within the specified project version regardless of their publication status the publication state of each article is identified by the status field in the api response supported status values include 0 draft 3 published as the endpoint does not currently support filtering by publication status both draft and published articles are returned in the response how to fix it to retrieve only published articles call the get list of articles within a project version api endpoint filter the response to include only articles where status 3 extract the article ids from the filtered results use the filtered article ids with the gets an article api endpoint to retrieve the content of the published articles additional information currently the get list of articles within a project version api endpoint does not provide a query parameter or path parameter to return only published articles filtering the response based on the status field is the recommended method for identifying and retrieving published content the ispublished parameter exists on individual resource endpoints gets an article gets a category but not on list endpoints do not use ispublished to filter list results was this article helpful yes no previous article how to use swagger next article troubleshooting api spec configuration issues related articles getting started with api documentation api documentation getting started with api documentation api fundamentals interactive decision tree api documentation managing api references api documentation getting started with api documentation document360 customers pricing resources request a demo migration request security private hosting enterprise readiness top features knowledge base portal knowledge base site knowledge base assistant integrations and extensions platform api analytics workflow ticket deflector drive seo support documentation support status feedback contact us contact us support document360 com rating 4 7 3000 about us our team our culture careers terms trust center privacy policy cookie policy soc2
|
