Skip to content

docs: "spec" is the standard, not the document #6

@hanspagel

Description

@hanspagel

hey, what a great project! it’s pretty common to use spec to refer to an OpenAPI file, we did this, too.

I’m super picky with wording, though and there is this a great OpenAPI glossary which helps here:
https://github.com/apisyouwonthate/api-glossary

TL;DR

  • "spec" refers to the specification, the OpenAPI standard
  • the file is what we call the OpenAPI document
  • and the document contains an API definition

I mean, it’s not super horrible to go with "spec" (because most projects do), but on the other hand a new project is a great opportunity trying to fix that. :)

take from it what you want. just feedback from someone who is super picky with that stuff. ❤

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions