openapi-specification-v3.2

OpenAPI Specification 3.2 — write and interpret OpenAPI descriptions (OAD), paths, operations, parameters, request/response, schema (JSON Schema 2020-12), security, and extensions. Use when authoring or validating OpenAPI 3.2 documents.

Safety Notice

This listing is imported from skills.sh public index metadata. Review upstream SKILL.md and repository scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "openapi-specification-v3.2" with this command: npx skills add hairyf/skills/hairyf-skills-openapi-specification-v3-2

OpenAPI Specification 3.2

Agent-oriented reference for the OpenAPI Specification 3.2.0. Use when editing, generating, or validating OpenAPI descriptions (OAD).

When to Use

  • Authoring or updating OpenAPI 3.2 YAML/JSON documents
  • Resolving $ref, $self, and relative URIs in multi-document OADs
  • Describing paths, operations, parameters (query/path/header/cookie/querystring), request body, and responses
  • Using Schema Objects (JSON Schema Draft 2020-12 dialect), components, and references
  • Configuring security schemes (apiKey, http, mutualTLS, oauth2, openIdConnect) and requirements
  • Working with media types, encoding (form, multipart), and examples (dataValue/serializedValue/externalValue)

Core References

TopicDescriptionReference
OpenAPI ObjectRoot object, openapi, $self, info, servers, paths, webhooks, components, security, tagscore-openapi-object
Format & StructureJSON/YAML, case sensitivity, rich text, OAD structure, parsing, base URIcore-format-and-structure
Fixed & Patterned FieldsFixed vs patterned fields, paths keys, components keys, extensions (x-)core-fixed-patterned-fields
Info & MetadataInfo, Contact, License objectscore-info-metadata
ServerServer Object, Server Variable, URL templatingcore-server
Paths & OperationsPaths Object, Path Item, Operation Object, additionalOperations, querypaths-and-operations
Path TemplatingPath templating, path parameters, matching, ABNFcore-path-templating
ParametersParameter Object, in (path/query/header/cookie/querystring), style, schema vs contentparameters
Request Body & Media TypeRequest Body, Media Type Object, sequential media types, itemSchemarequest-body-and-media-type
Encoding ObjectEncoding by name/position, contentType, style, explode, form, multipartcore-encoding-object
Media TypesContent keys, media type ranges, OpenAPI Media Type Registrycore-media-types
ResponsesResponses Object, Response Object, headers, content, linksresponses
HTTP Status CodesResponse keys, default, 1XX–5XX range with Xcore-http-status-codes
Schema & ComponentsSchema Object (JSON Schema 2020-12), Components, $ref resolutionschema-and-components
Schema JSON Schema KeywordsJSON Schema 2020-12 keywords and OAS extensions in Schemaschema-json-schema-keywords
Schema Composition & PolymorphismallOf, oneOf, anyOf, discriminatorschema-composition-polymorphism
Data Types & FormatsJSON Schema types, format keyword, OAS dialectcore-data-types-and-formats
Discriminator & XMLDiscriminator Object, XML Object (nodeType, name, namespace)core-discriminator-and-xml
Components ReuseReusing parameters, responses, schemas via $refcomponents-reuse
Reference Object$ref, summary/description override, resolution rulescore-reference-object
Header ObjectResponse/multipart headers, style simple, Set-Cookie, Linkcore-header-object
Example ObjectdataValue, serializedValue, value, externalValue, Working with Examplescore-example-object
Tag & External DocsTag Object, External Documentation Object, parent, kindcore-tags-and-external-docs
Link ObjectoperationRef, operationId, parameters, requestBodycore-link-object
Runtime Expressions$request, $response, $url, $method, ABNF, Link/Callback usagecore-runtime-expressions
SecuritySecurity Scheme, OAuth Flows, Security Requirement Objectsecurity
Security Scheme TypesapiKey, http (basic/bearer), mutualTLS, oauth2, openIdConnectsecurity-scheme-types
Security Requirement ObjectOR/AND semantics, {} optional, [] clear, scopessecurity-requirement-object
OAuth2 FlowsOAuth Flows Object, OAuth Flow Object, authorizationCode, deviceAuthorizationsecurity-oauth2-flows
Callbacks & WebhooksCallback Object, webhookscallbacks-and-webhooks
ExtensionsSpecification extensions (x-), extension registriesadvanced-extensions

Best Practices

TopicDescriptionReference
Spec AuthoringoperationId, tags, $self, components reuse, responses, securitybest-practices-spec-authoring

Advanced

TopicDescriptionReference
Base URI & Resolution$self, retrieval URI, reference resolution, parsing guidanceadvanced-base-uri-and-resolution
Security FilteringEmpty Paths/Path Item, Security Considerationsadvanced-security-filtering

Key Points

  • OAS 3.2 root uses openapi: 3.2.0; at least one of components, paths, or webhooks MUST be present.
  • $self provides the document's base URI for reference resolution; use it in multi-document OADs.
  • Schema Object is a superset of JSON Schema Draft 2020-12; empty schema = true, none = false.
  • Parameter: use either schema+style or content (one Media Type); in: "querystring" requires content.
  • Security at root is OR (one of the Security Requirement Objects); per-operation overrides; {} = optional.
<!-- Source: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.2.0.md -->

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

General

tailwindcss

No summary provided by upstream source.

Repository SourceNeeds Review
753-hairyf
General

hairy-utils

No summary provided by upstream source.

Repository SourceNeeds Review
689-hairyf
General

react-use

No summary provided by upstream source.

Repository SourceNeeds Review
503-hairyf
General

motion

No summary provided by upstream source.

Repository SourceNeeds Review
487-hairyf