Project

General

Profile

Feature #26101

Umbrella #25917: Move business logic from Django to middlewared and make websocket API feature complete

REST v2.0 OpenAPI Specification

Added by William Grzybowski almost 3 years ago. Updated almost 3 years ago.

Status:
Resolved
Priority:
Important
Assignee:
William Grzybowski
Category:
Middleware
Target version:
Estimated time:
Severity:
New
Reason for Closing:
Reason for Blocked:
Needs QA:
No
Needs Doc:
Yes
Needs Merging:
Yes
Needs Automation:
No
Support Suite Ticket:
n/a
Hardware Configuration:

Description

We need an OpenAPI specification for the REST 2.0.

To put it simply, its a json document describing every endpoint.

Associated revisions

Revision a4be0fe1 (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared/rest): openapi.json (blank, for now) Ticket: #26101

Revision 41e9048b (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared): first pass at adding endpoints to OpenAPI spec Ticket: #26101

Revision 3588c316 (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared): treat `do_update` specially for ConfigService Ticket: #26101

Revision df4b372d (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared/rest): openapi.json (blank, for now) Ticket: #26101

Revision c2a2e595 (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared): first pass at adding endpoints to OpenAPI spec Ticket: #26101

Revision f3f8e17e (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared): treat `do_update` specially for ConfigService Ticket: #26101

Revision 85c857fe (diff)
Added by William Grzybowski almost 3 years ago

fix(rc): set Host header for the REST 2.0 proxy Ticket: #26101

Revision d16bb118 (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared/rest): add `servers` attribute to OpenAPI Ticket: #26101

Revision 1e48a6c4 (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared/rest): add `components` attribute to OpenAPI Ticket: #26101

Revision 1701b4c4 (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared/rest): add securitiy and operation description Ticket: #26101

Revision 7057da7e (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared): skip private services and mark `datastore` one Ticket: #26101

Revision b4a6f311 (diff)
Added by William Grzybowski almost 3 years ago

fix(middlewared/rest): do not register operation without the method name Ticket: #26101

Revision 7ba8aafc (diff)
Added by William Grzybowski almost 3 years ago

fix(middlewared/rest): skip methods requiring websocket Ticket: #26101

Revision 3509ec00 (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared/rest): register all methods parameters Ticket: #26101

Revision 2b700acd (diff)
Added by William Grzybowski almost 3 years ago

fix(middlewared/rest): more accurate json schema repr for Any schema Ticket: #26101

Revision c26922dc (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared/rest): use service namespace as a tag Ticket: #26101

Revision 3a01d618 (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared/zfs): implement basic zfs.snapshot.query Ticket: #26101

Revision c1c5fc9b (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared/rest): map methods with multiple args to an object/dict Ticket: #26101

Revision f6d7ad5c (diff)
Added by William Grzybowski almost 3 years ago

fix(middlewared/tests): catch up API change and normalize Ticket: #26101

Revision 0d02dafa (diff)
Added by William Grzybowski almost 3 years ago

fix(middlewared/rest): no payload means no args Ticket: #26101

Revision 8c08632a (diff)
Added by William Grzybowski almost 3 years ago

fix(middlewared/rest): skip first param for `item_method` Ticket: #26101

Revision 62b8c4b1 (diff)
Added by William Grzybowski almost 3 years ago

fix(middlewared/restd): catch up API change on all tests Ticket: #26101

Revision 4af56a9e (diff)
Added by William Grzybowski almost 3 years ago

fix(middlewared/rest): skip first param for `item_method` methods Ticket: #26101

Revision 800298dd (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared/rest): add `id` path parameter Ticket: #26101

Revision d471de61 (diff)
Added by William Grzybowski almost 3 years ago

fix(middlewared/rest): `in` paremeter requires a schema Ticket: #26101

Revision 6a084a45 (diff)
Added by William Grzybowski almost 3 years ago

fix(middlewared/bootenv): missing accepts decorator for `delete` Ticket: #26101

Revision 56c7fb48 (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared/restful): register default schema if method doesnt have one Ticket: #26101

Revision 3c725a2a (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared/rest): use OpenAPI as root url for API Ticket: #26101

Revision 4c18b306 (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared/rest): mark some methods private Ticket: #26101

Revision 648563c7 (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared/rest): add parameters for `filterable` methods Ticket: #26101

Revision aeea43c7 (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared/rest): add swagger-ui port Ticket: #26101

Revision dc5e9f37 (diff)
Added by William Grzybowski almost 3 years ago

fix(ports): typo Ticket: #26101

Revision 522c4b1f (diff)
Added by William Grzybowski almost 3 years ago

fix(ports): dir to copy swaghger-ui to Ticket: #26101

Revision 13ea57e4 (diff)
Added by William Grzybowski almost 3 years ago

fix(ports: use WRKSRC and not WRKDIR Ticket: #26101

Revision 95d7c616 (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared/rest): add RESTful to /api/docs Ticket: #26101

Revision 21b6e373 (diff)
Added by William Grzybowski almost 3 years ago

feat(middlewared/rest): add static files for swagger in nginx Ticket: #26101

Revision 2b71e0e1 (diff)
Added by William Grzybowski almost 3 years ago

fix(middlewared/rest): update pkg-descr for swagger-ui Ticket: #26101

Revision fe409588 (diff)
Added by William Grzybowski almost 3 years ago

fix(middleware/rest): pep8 Ticket: #26101

Revision f74c4925 (diff)
Added by William Grzybowski almost 3 years ago

fix(middlewared): more pep8 Ticket: #26101

History

#1 Updated by William Grzybowski almost 3 years ago

  • Subject changed from REST v2.0 Swagger Specification to REST v2.0 OpenAPI Specification
  • Description updated (diff)

#2 Updated by William Grzybowski almost 3 years 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 almost 3 years 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 almost 3 years ago

  • Status changed from Needs Developer Review to Ready For Release
  • Assignee changed from Vladimir Vinogradenko to William Grzybowski

#5 Updated by Dru Lavigne almost 3 years ago

  • Status changed from Ready For Release to Resolved

#6 Updated by Joe Maloney almost 3 years ago

  • Needs QA changed from Yes to No

Also available in: Atom PDF