Feature #26101
Umbrella #25917: Move business logic from Django to middlewared and make websocket API feature complete
REST v2.0 OpenAPI Specification
Description
We need an OpenAPI specification for the REST 2.0.
To put it simply, its a json document describing every endpoint.
Associated revisions
feat(middlewared): first pass at adding endpoints to OpenAPI spec
Ticket: #26101
feat(middlewared): treat `do_update` specially for ConfigService
Ticket: #26101
feat(middlewared/rest): openapi.json (blank, for now)
Ticket: #26101
feat(middlewared): first pass at adding endpoints to OpenAPI spec
Ticket: #26101
feat(middlewared): treat `do_update` specially for ConfigService
Ticket: #26101
fix(rc): set Host header for the REST 2.0 proxy
Ticket: #26101
feat(middlewared/rest): add `servers` attribute to OpenAPI
Ticket: #26101
feat(middlewared/rest): add `components` attribute to OpenAPI
Ticket: #26101
feat(middlewared/rest): add securitiy and operation description
Ticket: #26101
feat(middlewared): skip private services and mark `datastore` one
Ticket: #26101
fix(middlewared/rest): do not register operation without the method name
Ticket: #26101
fix(middlewared/rest): skip methods requiring websocket
Ticket: #26101
feat(middlewared/rest): register all methods parameters
Ticket: #26101
fix(middlewared/rest): more accurate json schema repr for Any schema
Ticket: #26101
feat(middlewared/rest): use service namespace as a tag
Ticket: #26101
feat(middlewared/zfs): implement basic zfs.snapshot.query
Ticket: #26101
feat(middlewared/rest): map methods with multiple args to an object/dict
Ticket: #26101
fix(middlewared/tests): catch up API change and normalize
Ticket: #26101
fix(middlewared/rest): no payload means no args
Ticket: #26101
fix(middlewared/rest): skip first param for `item_method`
Ticket: #26101
fix(middlewared/restd): catch up API change on all tests
Ticket: #26101
fix(middlewared/rest): skip first param for `item_method` methods
Ticket: #26101
feat(middlewared/rest): add `id` path parameter
Ticket: #26101
fix(middlewared/rest): `in` paremeter requires a schema
Ticket: #26101
fix(middlewared/bootenv): missing accepts decorator for `delete`
Ticket: #26101
feat(middlewared/restful): register default schema if method doesnt have one
Ticket: #26101
feat(middlewared/rest): use OpenAPI as root url for API
Ticket: #26101
feat(middlewared/rest): mark some methods private
Ticket: #26101
feat(middlewared/rest): add parameters for `filterable` methods
Ticket: #26101
feat(middlewared/rest): add swagger-ui port
Ticket: #26101
fix(ports): typo
Ticket: #26101
fix(ports): dir to copy swaghger-ui to
Ticket: #26101
fix(ports: use WRKSRC and not WRKDIR
Ticket: #26101
feat(middlewared/rest): add RESTful to /api/docs
Ticket: #26101
feat(middlewared/rest): add static files for swagger in nginx
Ticket: #26101
fix(middlewared/rest): update pkg-descr for swagger-ui
Ticket: #26101
fix(middleware/rest): pep8
Ticket: #26101
fix(middlewared): more pep8
Ticket: #26101
History
#1
Updated by William Grzybowski over 1 year ago
Updated by William Grzybowski - Subject changed from REST v2.0 Swagger Specification to REST v2.0 OpenAPI Specification
- Description updated (diff)
#2
Updated by William Grzybowski over 1 year ago
- Tracker changed from Umbrella to Feature
- % Done set to 0
- Needs QA set to Yes
- QA Status Not Tested added
#3
Updated by William Grzybowski over 1 year ago
- Status changed from Screened to Needs Developer Review
- Assignee changed from William Grzybowski to Vladimir Vinogradenko
- Target version changed from 11.2-BETA1 to 11.1-BETA1
#4
Updated by William Grzybowski over 1 year ago
- Status changed from Needs Developer Review to Ready For Release
- Assignee changed from Vladimir Vinogradenko to William Grzybowski
#5
Updated by Dru Lavigne over 1 year ago
Updated by Dru Lavigne - Status changed from Ready For Release to Resolved
#6
Updated by Joe Maloney over 1 year ago
Updated by Joe Maloney - Needs QA changed from Yes to No
feat(middlewared/rest): openapi.json (blank, for now)
Ticket: #26101