Meta tags:
description= Generate clear, interactive API documentation effortlessly with Document360 by uploading your API specs, supporting OpenAPI and CI/CD flows.;
Headings (most frequently used words):
api, resync, documentation, from, url, references, create, new, reference, keeping, in, category, spec, via, ci, cd, managing, index, list, actions, your, sync, automatic, vs, manual, understanding, endpoint, deletion, during, draft, nested, categories, ordering, options, updating, generated, content, the, faq, helpful, links, upload, definition, flow, an, existing, update, to, regenerate, file, document360, top, features, support, contact, us,
Text of the page (most frequently used words):
the (131), api (85), your (39), spec (36), documentation (32), #reference (29), from (28), file (27), and (25), you (24), articles (22), can (21), #resync (19), click (19), document360 (18), article (18), url (18), with (16), are (16), content (16), update (15), new (15), knowledge (14), base (14), references (13), endpoint (13), category (13), this (12), portal (11), create (11), automatically (11), for (11), generated (10), publish (10), not (10), edit (10), site (9), categories (9), draft (9), flow (9), endpoints (9), upload (9), yes (8), openapi (8), all (8), updated (8), drive (7), next (7), folder (7), custom (7), note (7), using (6), window (6), same (6), via (6), specification (6), any (6), download (6), review (6), list (6), view (6), tags (5), managing (5), that (5), source (5), readers (5), during (5), access (5), workspace (5), levels (5), created (5), integrate (5), type (5), changes (5), definition (5), change (5), more (5), deleted (5), select (5), 2026 (5), support (4), analytics (4), integrations (4), getting (4), started (4), set (4), when (4), does (4), also (4), details (4), uploading (4), will (4), mode (4), they (4), have (4), move (4), within (4), but (4), manually (4), use (4), see (4), pipeline (4), available (4), icon (4), page (4), about (3), top (3), features (3), request (3), was (3), one (3), manage (3), d360 (3), pets (3), nested (3), supports (3), three (3), third (3), level (3), instead (3), confirmation (3), keep (3), cannot (3), between (3), automatic (3), non (3), which (3), only (3), confirm (3), than (3), permissions (3), pages (3), cli (3), add (3), inside (3), pane (3), options (3), order (3), before (3), keeping (3), proceed (3), added (3), import (3), manual (3), latest (3), regenerate (3), version (3), existing (3), sync (3), warnings (3), actions (3), every (3), navigation (3), ask (3), open (3), policy (2), our (2), com (2), contact (2), feedback (2), workflow (2), extensions (2), private (2), hosting (2), security (2), interactive (2), decision (2), helpful (2), application (2), defined (2), another (2), apis (2), through (2), their (2), its (2), own (2), programmatically (2), run (2), continue (2), downtime (2), symbol (2), creates (2), structure (2), preserved (2), folders (2), subcategories (2), how (2), after (2), close (2), subfolders (2), different (2), resynced (2), updates (2), multiple (2), these (2), time (2), like (2), regular (2), rather (2), token (2), updating (2), other (2), standard (2), swagger (2), read (2), current (2), original (2), subcategory (2), sub (2), rename (2), what (2), right (2), clicking (2), gives (2), following (2), tag (2), name (2), based (2), publishing (2), resyncing (2), send (2), preview (2), forceimport (2), where (2), deletion (2), show (2), permanently (2), command (2), part (2), full (2), integration (2), apidocs (2), json (2), yaml (2), yml (2), enter (2), need (2), alerts (2), delete (2), local (2), storage (2), into (2), radio (2), button (2), them (2), directly (2), device (2), each (2), sample (2), fetch (2), bar (2), left (2), claude (2), chatgpt (2), markdown (2), copy (2), llms (2), ctrl (2), search (2), glossary (2), october (2), docs (2), index (2), soc2, cookie, privacy, trust, center, terms, careers, culture, team, 3000, rating, status, seo, ticket, deflector, platform, assistant, enterprise, readiness, migration, demo, resources, pricing, customers, tree, fundamentals, related, previous, programming, interface, rules, protocols, allows, software, communicate, functionality, backbone, modern, connects, slack, intercom, google, provides, rest, enabling, teams, reader, accounts, external, systems, code, npm, package, links, get, calls, customer, independently, accessing, scheduled, maintenance, hierarchical, additional, collapsed, many, supported, saved, share, however, exist, under, subdomain, specific, must, enable, often, faq, contributors, just, apply, edited, blocks, receive, 403, error, while, attempting, first, working, process, above, adjusting, tokens, guidance, reviewing, keeps, consistent, such, concept, authentication, guides, tied, managed, reflect, retrieved, way, modify, possible, configure, who, link, option, appear, matches, reorder, array, ordering, defines, nesting, beyond, placed, definitions, visible, accessible, remain, resulting, immediately, without, proceeding, true, false, moved, previewed, days, restored, recycle, bin, checkbox, acknowledge, warning, displayed, affected, safely, longer, present, along, those, understanding, runs, creation, method, setting, apikey, your_api_key, userid, your_user_id, apireferenceid, your_api_reference_id, path, path_to_spec_file, happens, whenever, trigger, format, field, regenerates, want, individual, retained, parameters, responses, modified, regenerating, pulls, allow, ensure, toggle, turned, settings, errors, most, recent, logs, raw, action, once, setup, instructions, lets, fetches, processes, pointing, parses, generates, detected, expand, section, drag, drop, choose, postman, specifications, maximum, explore, try, pet, store, requires, node, hosted, dropdown, opens, four, here, last, date, corner, central, configured, navigate, covers, everything, creating, organize, prev, summary, plain, text, print, listen, focus, minute, published, feb, sep, powered, press, community, feature, self, service, troubleshooting, help, november, release, notes, manager, domain, customization, export, project, reminder, collaboration, tasks, trees, fields, management, templates, variables, snippets, advanced, editor, single, sign, role, control, workspaces, languages, key, creators, eddy, track, roles, invite, users, customize, quick, start, discover, exploring, further, complete, https, txt,
Text of the page (random words):
managing api references 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 managing api references updated on sep 28 2026 published on feb 23 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 covers everything you need to manage your api references in document360 creating new references keeping them in sync with your spec and using the available actions to view edit publish and organize your api documentation api references list the api references list gives you a central view of all configured api references in your workspace to access it navigate to api documentation in the left navigation bar and click api references in the left navigation pane from here you can see the name type and last updated date for each reference you can also create a new api reference by clicking new api in the top right corner create a new api reference to create a new api reference click the create dropdown in the top navigation bar and select new api this opens the new api reference window where you have four options upload api definition upload a json yaml or yml spec file directly from your device or from document360 drive create from url fetch your spec automatically from a hosted url ci cd flow integrate with your pipeline to update documentation automatically on every spec change requires node js try sample pet store api file use document360 s sample spec file to explore the workspace before uploading your own note document360 supports openapi 2 0 openapi 3 0 openapi 3 1 and postman api specifications within each api workspace you can create a maximum of 3 api references upload api definition select the upload api definition radio button click upload from my device to upload from your local storage or choose from drive to select a file from document360 drive you can also drag and drop your file directly into the window document360 parses the file and generates the api reference if warnings are detected expand the alerts and warnings section to review them click new api reference to proceed to the publish confirmation window create from url select the create from url radio button and click next enter the url pointing to your openapi specification file click new api reference document360 fetches and processes the spec ci cd flow the ci cd flow lets you keep your api documentation automatically in sync with your spec instead of manually uploading a new spec every time your api changes you integrate the document360 cli into your pipeline so documentation updates automatically on every spec change for full setup instructions see the ci cd integration article api reference actions once an api reference is created click the more icon next to it in the api references list to access the following actions action what it does edit update the spec file or url the reference was created from resync regenerate the documentation from the latest version of the spec at the existing url view api definition preview the raw api specification file download original api source download the current version of the spec file to your local storage publish publish all draft articles in the api reference to the knowledge base site delete permanently delete the api reference and all its generated content view logs review alerts warnings and errors from the most recent import or resync note to allow readers to download the api source file from the knowledge base site ensure the show download api source toggle is turned on in the knowledge base portal settings keeping your documentation in sync when your api changes new endpoints added parameters updated responses modified but you do not need to update your documentation manually regenerating your api reference pulls in all changes from your spec automatically note any custom content you have added to individual endpoint articles is retained when you regenerate your documentation only the spec generated content is updated resync from an existing url in the api references list click the more icon next to the reference you want to update click resync the documentation regenerates from the latest version of the spec at the existing url update to a new url click the more icon next to the reference click edit enter the new url in the url field click update regenerate from a spec file click the more icon next to the reference click edit upload the latest spec file in json yaml or yml format click update resync via ci cd if your api reference was set up with the ci cd flow resyncing happens automatically as part of your pipeline whenever your spec changes you can also trigger a manual resync using the apidocs resync command d360 apidocs resync apikey your_api_key userid your_user_id apireferenceid your_api_reference_id path path_to_spec_file for full details on setting up and managing the ci cd flow see the ci cd integration article automatic vs manual resync creation method automatic resync manual resync file upload not available yes via edit in the portal url import not available yes via resync or edit in the portal ci cd flow yes runs as part of your pipeline yes run the cli command manually if you generated your api documentation from a url or a file it will not update automatically to have documentation update automatically integrate with the ci cd flow understanding endpoint deletion during resync when you update your api specification file any endpoints that are no longer present in the new spec are permanently deleted along with any custom content added to those endpoint pages to update your spec file safely upload the updated spec file in the edit api reference window if any endpoints are deleted a warning is displayed click show deleted endpoints to review the list of affected endpoints select the confirm to continue checkbox to acknowledge the deletion click update to proceed deleted endpoints are moved to the recycle bin where they can be previewed for up to 30 days but cannot be restored note if you are using the resync api endpoint programmatically send forceimport false to preview the list of endpoints that will be deleted without proceeding send forceimport true to confirm and proceed keeping documentation in draft after uploading or resyncing a spec you can keep the resulting documentation in draft mode rather than publishing it immediately in the publish confirmation window click close instead of publish all generated articles will remain in draft mode draft articles are visible in the categories articles pane in the portal but are not accessible to readers on the knowledge base site you can review edit and add custom content to draft articles before publishing nested categories document360 supports up to three levels of subcategories in the api documentation workspace categories are created based on the tag definitions in your spec file to create nested categories use the symbol in your openapi tags tags name pets details this creates a pets category with a details subcategory inside it this structure is preserved during resync note if your spec defines more than three levels of nesting any categories beyond the third level are placed at the third level category ordering the order in which categories appear in your documentation matches the tag order defined in your spec file to change the category order reorder the tags array in your spec and resync category options right clicking a category in the categories articles pane gives you the following options option what it does rename rename the category article add a new article or sub article inside the category sub category add a subcategory inside the category change type change the category type set drive folder link the category to a document360 drive folder edit api reference update the spec file or url for the api reference download original api source download the current spec file publish publish all draft articles in the category security configure who can access the category from the portal and the knowledge base site note you can move endpoint articles between subfolders within the same api reference folder it is not possible to move an endpoint article from one api reference folder to a different api reference folder updating spec generated content via the api endpoint articles generated from an api specification openapi or swagger are read only through the standard content api endpoints they cannot be retrieved or updated that way to modify this type of content update your api definition file openapi swagger resync the documentation using the portal cli or ci cd flow to reflect the changes this keeps your endpoint reference content consistent with your api specification regular knowledge base articles such as concept pages authentication guides or other non spec content are not tied to the api specification these can be created updated and managed like any other knowledge base content using the standard content api endpoints if you receive a 403 error while attempting to update content via the api first confirm which type of content you re working with if it s spec generated content use the resync process above rather than adjusting token permissions if it s a non spec article see api tokens for guidance on reviewing and updating token permissions note multiple contributors can edit these non spec articles at the same time just like regular knowledge base articles this does not apply to spec generated endpoint articles which can only be edited within their custom content blocks faq how often is an api reference resynced automatically api references created from a url or file are not resynced automatically they must be updated manually via the portal to enable automatic updates integrate with the ci cd flow can i move a specific api endpoint article from one api reference folder to another no you can move endpoint articles between subfolders within the same api reference folder but not between different api reference folders can an api documentation article have the same url as a knowledge base article no api documentation articles and knowledge base articles cannot share the same url however they can exist under the same subdomain can i keep generated documentation in draft mode yes after uploading a spec click close instead of publish in the confirmation window all generated articles will be saved in draft mode how many levels of categories are supported the api documentation workspace supports up to three levels of subcategories additional levels are collapsed to the third level can i create nested folders automatically from the spec file yes using the symbol in openapi tags e g pets details this creates a hierarchical structure that is preserved during resync 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 helpful links d360 npm package d360 source code application programming interface a set of defined rules and protocols that allows one software application to communicate with and request functionality from another apis are the backbone of modern integrations when document360 connects to slack intercom or google analytics it does so through their apis document360 also provides its own rest api enabling teams to programmatically manage articles categories and reader accounts from external systems was this article helpful yes no previous article getting started with api documentation next article managing endpoint articles related articles getting started with api documentation api documentation getting started with api documentation api fundamentals interactive decision tree api documentation managing endpoint articles api documentation getting started with api documentation tags api references api 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
|
