#Collection V3

12 messages · Page 1 of 1 (latest)

regal karma
#

Can you give me an overview of the new yml based collection structure?

leaden topazBOT
#

Hey @regal karma 👋 I’m Kapa, your AI teammate here in Postman’s Discord. I’ll dig into our knowledge base to fine the best answer for you. Hang tight a sec while I look that up.

#

I’m sorry, but the provided knowledge sources don’t contain a technical description of the new YAML-based “Collection V3” structure (fields, schema layout, or examples). They only mention it in passing:

  • Native Git workflows save “Postman Collection V3 YAML files under postman/,” but don’t show the format itself. [Develop with Git]
  • The docs note that Postman collections are based on the open-source collection format and link to the schema site, but don’t distinguish between V2 and V3 or show a V3-specific schema. [Collection format]

Because there’s no explicit V3/YAML schema or structural overview in these sources, I can’t reliably describe the new structure (top-level keys, differences from 2.1, etc.) without guessing.

From what is in the sources, you can infer:

#
  • Collections (including V3) still represent:
    • A set of requests (HTTP, GraphQL, gRPC, etc.) with auth, params, headers, body, tests, variables, and docs. [Collections overview]
    • Organized into folders and subfolders, used for testing, automation, docs, mocks, and monitors. [Use collections]
  • In newer workflows, collections can:
    • Be stored as YAML files in Git (V3 format) and edited via Native Git. [Develop with Git]
    • Include “types” on parameters, headers, and bodies, which are then used to generate OpenAPI specs and validate requests. [Design with collections; Generate specs]

For a precise overview of the V3 YAML structure (schema fields, examples, and differences from 2.1), the knowledge sources direct you to the general collection schema site, but they don’t embed that content here. [Collection format]

So within these constraints, I can’t provide the detailed V3 YAML layout you’re asking for.

Note: you can ask me a follow up question by @ mentioning me again :speech_balloon:

#

@regal karma I’m always learning. If my answer helped (or missed the mark), let me know by reacting below. Your feedback helps me improve so I can support you and the community even better.

regal karma
#

@coral roost this will be more useful when your docs are up to date

coral roost
#

That particular information wouldn't be part of the data set at the moment as the team involved in creating the relevant public information for this format.

It will be similar to what we have for the JSON schemas here https://schema.postman.com/

Is there something specific that you need an answer for, rather than just a general overview?

coral roost
#

I've reached out to the team to get a timeline on when more information about the v3 Collection will be published.

regal karma
#

As a customer, it doesn't really matter to me which team looks after what information internally.

I have lots of specific questions but they're all moot until the docs are ready. Postman just had a massive feature go live and your docs are lagging behind.

Thank you for following up 🙂

coral roost
#

Agree and there will be fast follow ups on these. 🙏

You could also get to the point where the most up to date docs also don't fully answer every question that you might have. Those questions can still be raised for the team to answer.

You can reach us here, Discourse, Github, Our socials channels (X, LinkedIn, Bluesky), the support team via [email protected]. We're always here to help.

regal karma
coral roost
#

I'm confused, you previously mentioned that you had lots of specific questions. 🤔

  • What's the tool?
  • How are you going to be using that in your workflow?
  • Do you currently have a v2 equivalent?
  • Have you been able to create a v3 Collection from a current v2 Collection or using the Local View feature and see the file structure?

Migration of an existing full Collection might give you more of an idea about the structure:

https://learning.postman.com/docs/postman-cli/postman-cli-collections#postman-collection-migrate