# Automatic Documentation Generation on API Schema Sync

**URL:** <https://community.postman.com/t/automatic-documentation-generation-on-api-schema-sync/14890>\
**Category:** Help Hub\
**Tags:** documentation, api-documentation, integration\
**Created:** [August 11, 2020, 6:56am UTC](https://community.postman.com/t/automatic-documentation-generation-on-api-schema-sync/14890 "2020-08-11T06:56:47Z")\
**Posts on this page:** 5\
**Page:** 1

<div class="post-metadata">

**Author:** ![zhe.wang](https://sea2.discourse-cdn.com/getpostman/user_avatar/community.postman.com/zhe.wang/32/5236_2.png) [@zhe.wang](https://community.postman.com/u/zhe.wang)\
**Post date:** [August 11, 2020, 6:56am UTC](https://community.postman.com/t/automatic-documentation-generation-on-api-schema-sync/14890/1 "2020-08-11T06:56:47Z")

</div>

Hi Postman team,

I have a working API Schema (OpenAPI) integration set up where my GitHub repo commits sync with a Postman API’s definition.

Is it possible to automatically update Postman Documentation associated with the API when the schema definition updates? It seems an API Documentation Collection needs to be manually generated to include the OpenAPI schema updates.

Regards,  
Zhe

---

<div class="post-metadata">

**Author:** ![zhe.wang](https://sea2.discourse-cdn.com/getpostman/user_avatar/community.postman.com/zhe.wang/32/5236_2.png) [@zhe.wang](https://community.postman.com/u/zhe.wang)\
**Post date:** [August 12, 2020, 6:45am UTC](https://community.postman.com/t/automatic-documentation-generation-on-api-schema-sync/14890/2 "2020-08-12T06:45:08Z")

</div>

I’m considering hooking up a GitHub action to [programmatically create a collection from schema](https://documenter.getpostman.com/view/631643/JsLs/?version=latest#ad78fb79-f110-462d-8441-1278216ee24a) if there’s no other automated way to do so via the schema update.

---

<div class="post-metadata">

**Author:** ![zhe.wang](https://sea2.discourse-cdn.com/getpostman/user_avatar/community.postman.com/zhe.wang/32/5236_2.png) [@zhe.wang](https://community.postman.com/u/zhe.wang)\
**Post date:** [August 13, 2020, 6:23am UTC](https://community.postman.com/t/automatic-documentation-generation-on-api-schema-sync/14890/3 "2020-08-13T06:23:29Z")

</div>

I ended up writing a [Node CLI](https://github.com/auzwang/swagger2-postman-doc) to do this as part of a BuildKite step instead of messing around with integrations.

---

<div class="post-metadata">

**Author:** ![Kurmavatar](https://sea2.discourse-cdn.com/getpostman/user_avatar/community.postman.com/kurmavatar/32/3026_2.png) [@Kurmavatar](https://community.postman.com/u/Kurmavatar)\
**Post date:** [August 14, 2020, 10:39am UTC](https://community.postman.com/t/automatic-documentation-generation-on-api-schema-sync/14890/4 "2020-08-14T10:39:35Z")

</div>

Glad to hear that 🥳

Leaving this [screen-record](https://www.youtube.com/watch?v=f2mufOoVU98) here as a reference for other users looking for a solution, to also attempt this method to update existing collection/ documentation from the GitHub synced API.

---

<div class="post-metadata">

**Author:** ![dougsillars](https://sea2.discourse-cdn.com/getpostman/user_avatar/community.postman.com/dougsillars/32/10659_2.png) [@dougsillars](https://community.postman.com/u/dougsillars)\
**Post date:** [December 16, 2021, 4:33pm UTC](https://community.postman.com/t/automatic-documentation-generation-on-api-schema-sync/14890/5 "2021-12-16T16:33:05Z")

</div>

The Node CLI is a great solution! But in my case, there are several of us updating the GitHub repo… Is there another way (or example GitHub action) that can PUT the update to Postman on commit?

Thanks!