OpenStack Compute (nova)

OpenAPI Schemas

Registered by Stephen Finucane

Add support for generating OpenAPI schemas from code.

Blueprint information

Status:
Complete
Approver:
sean mooney
Priority:
Undefined
Drafter:
Stephen Finucane
Direction:
Approved
Assignee:
Stephen Finucane
Definition:
Approved
Series goal:
Accepted for 2024.2
Implementation:
Implemented
Milestone target:
None
Started by
Sylvain Bauza
Completed by
Sylvain Bauza

Related branches

Sprints

Whiteboard

Gerrit topic: https://review.opendev.org/#/q/topic:openapi

Addressed by: https://review.opendev.org/c/openstack/nova/+/914083
    api: Add missing Controller inheritance

Addressed by: https://review.opendev.org/c/openstack/nova/+/914084
    api: Remove FlavorManageController

Addressed by: https://review.opendev.org/c/openstack/nova/+/915732
    api: Keep track of action controllers

Addressed by: https://review.opendev.org/c/openstack/nova/+/915733
    api: Add request body schemas for SG APIs

Addressed by: https://review.opendev.org/c/openstack/nova/+/915734
    api: Add remaining missing request body schemas

Addressed by: https://review.opendev.org/c/openstack/nova/+/915735
    tests: Ensure all APIs have a request body schema

Addressed by: https://review.opendev.org/c/openstack/nova/+/915736
    api: Add 'removed' decorator

Addressed by: https://review.opendev.org/c/openstack/nova/+/915737
    api: Don't do version check if nothing required

Addressed by: https://review.opendev.org/c/openstack/nova/+/915738
    api: Add remaining missing query parameter schema

Addressed by: https://review.opendev.org/c/openstack/nova/+/915739
    tests: Ensure all APIs have a request query schema

Addressed by: https://review.opendev.org/c/openstack/nova/+/915740
    conf: Add '[api] response_validation' option

Addressed by: https://review.opendev.org/c/openstack/nova/+/915741
    api: Add response body validation helper

Addressed by: https://review.opendev.org/c/openstack/nova/+/915742
    api: Add response body schemas for server action APIs

Addressed by: https://review.opendev.org/c/openstack/nova/+/915743
    api: Add response body schemas for remaining server action APIs

Addressed by: https://review.opendev.org/c/openstack/nova/+/915843
    api: Fix bugs in schemas

Addressed by: https://review.opendev.org/c/openstack/nova/+/915844
    tests: Ensure API schemas are valid

Addressed by: https://review.opendev.org/c/openstack/nova/+/915845
    api: Migrate to JSON Schema Draft 2020-12

Addressed by: https://review.opendev.org/c/openstack/nova-specs/+/919603
    Follow-up for openapi spec

[20240528 bauzas] Approved for the Dalmatian cycle

Addressed by: https://review.opendev.org/c/openstack/nova/+/923144
    api: Correct bug in flavors schema

Addressed by: https://review.opendev.org/c/openstack/nova/+/924501
    conf: Clarify '[api] response_validation help' text

Addressed by: https://review.opendev.org/c/openstack/nova/+/924584
    api: Add response body schemas for host aggregate actions API

Addressed by: https://review.opendev.org/c/openstack/nova/+/924585
    api: Add response body schemas for host aggregate APIs

Addressed by: https://review.opendev.org/c/openstack/nova/+/924586
    api: Add response body schemas for extensions API

Addressed by: https://review.opendev.org/c/openstack/nova/+/924587
    api: Add response body schemas for versions APIs

Addressed by: https://review.opendev.org/c/openstack/nova/+/924588
    api: Add response body schemas for assisted volume snapshots APIs

Addressed by: https://review.opendev.org/c/openstack/nova/+/924589
    api: Add response body schemas for port interface APIs

Addressed by: https://review.opendev.org/c/openstack/nova/+/924590
    api: Add response body schemas for availability zone APIs

Addressed by: https://review.opendev.org/c/openstack/nova/+/924591
    api: Add response body schemas for bare metal node APIs

Addressed by: https://review.opendev.org/c/openstack/nova/+/924592
    api: Add response body schemas for console auth token APIs

Addressed by: https://review.opendev.org/c/openstack/nova/+/924593
    api: Add response body schemas for flavor access API

Addressed by: https://review.opendev.org/c/openstack/nova/+/924594
    api: Add response body schemas for flavor extra specs APIs

Addressed by: https://review.opendev.org/c/openstack/nova/+/924595
    api: Add response body schemas for flavors APIs

Addressed by: https://review.opendev.org/c/openstack/nova/+/924596
    api: Add response body schemas for floating IP pool APIs

Addressed by: https://review.opendev.org/c/openstack/nova/+/924597
    docs: Add contributor docs for response body validation

Addressed by: https://review.opendev.org/c/openstack/nova/+/924598
    WIP: tests: Ensure all APIs have a response body schema

Addressed by: https://review.opendev.org/c/openstack/nova/+/924599
    WIP: tests: Temporarily ignore missing schemas for removed APIs

Addressed by: https://review.opendev.org/c/openstack/nova/+/924722
    api: Fix typo

[20240903 bauzas] Request schemas are changed but we need a part-2 in Epoxy for the response body schemas

Addressed by: https://review.opendev.org/c/openstack/nova-specs/+/928800
    Re-propose OpenAPI spec for Epoxy

Addressed by: https://review.opendev.org/c/openstack/nova/+/936362
    api: Remove use of microversion constants

Addressed by: https://review.opendev.org/c/openstack/nova/+/936363
    api: Allow min/max_version arguments to expected_errors

Addressed by: https://review.opendev.org/c/openstack/nova/+/936364
    api: Allow min/max_version arguments to response

Addressed by: https://review.opendev.org/c/openstack/nova/+/936365
    api: Adjust validation helpers for a single-method future

Addressed by: https://review.opendev.org/c/openstack/nova/+/936366
    api: Stop using wsgi.Controller.api_version to switch between API versions

Addressed by: https://review.opendev.org/c/openstack/nova/+/936367
    api: Add new, simpler api_version decorator

Addressed by: https://review.opendev.org/c/openstack/nova/+/936368
    api: Only run format checks on strings

Addressed by: https://review.opendev.org/c/openstack/nova/+/936369
    api: Simplify parameter types

Addressed by: https://review.opendev.org/c/openstack/nova/+/937012
    doc: Add missing API samples

Addressed by: https://review.opendev.org/c/openstack/nova/+/937013
    tests: Use UUIDs in TestOpenStackClient

Addressed by: https://review.opendev.org/c/openstack/nova/+/937047
    api: Add response body schemas for hosts APIs

Addressed by: https://review.opendev.org/c/openstack/nova/+/937048
    api: Add response body schemas for instance actions

Addressed by: https://review.opendev.org/c/openstack/nova/+/937245
    api: Add response body schemas for hypervisors APIs (1/3)

Addressed by: https://review.opendev.org/c/openstack/nova/+/937246
    api: Add response body schemas for hypervisors APIs (2/3)

Addressed by: https://review.opendev.org/c/openstack/nova/+/937247
    api: Add response body schemas for hypervisors APIs (3/3)

Addressed by: https://review.opendev.org/c/openstack/nova/+/937377
    trivial: Remove legacy API artifact

Addressed by: https://review.opendev.org/c/openstack/nova/+/937608
    api: Add response body schemas for server IPs APIs

Addressed by: https://review.opendev.org/c/openstack/nova/+/940114
    api: Add response body schemas for remote consoles

Addressed by: https://review.opendev.org/c/openstack/nova/+/940115
    api: Add response body schemas for keypairs APIs

Addressed by: https://review.opendev.org/c/openstack/nova/+/940299
    api: Add response body schemas for image metadata APIs

Addressed by: https://review.opendev.org/c/openstack/nova/+/940300
    api: Add response body schemas for server topology API

Addressed by: https://review.opendev.org/c/openstack/nova/+/940325
    api: Only check minimum API version

Addressed by: https://review.opendev.org/c/openstack/nova/+/940369
    api: project/tenant and user IDs are not UUIDs

Addressed by: https://review.opendev.org/c/openstack/nova/+/940506
    api: Add response body schemas for server diagnostics API

Addressed by: https://review.opendev.org/c/openstack/nova/+/940508
    api: Add response body schemas for server external events API

Addressed by: https://review.opendev.org/c/openstack/nova/+/943252
    api: Add response body schemas for for console auth token APIs (v2.99)

Addressed by: https://review.opendev.org/c/openstack/nova/+/943253
    api: Address TODO in microversion v2.99

Addressed by: https://review.opendev.org/c/openstack/nova/+/945736
    api: Add response body schemas for server password APIs

(?)

Work Items

Nearby

This blueprint contains Public information 
Everyone can see this information.
Edit subscription

Subscribers

No subscribers.